2.2.5.3 DataServiceVersion

This header is a custom HTTP header defined by this document for protocol versioning purposes. This header MAY be present on any request or response message.

The syntax of the DataServiceVersion header is defined as follows:

DataServiceVersion       =  "DataServiceVersion:"
                            VersionNum
                            [";"
                            VersionClientUserAgent]
                            CRLF

VersionNum               =  DIGIT *DIGIT "." DIGIT *DIGIT

VersionClientUserAgent   =  *token     ; see [RFC2616] section 2.2
                            ; SHOULD contain information about the user agent
                            ; originating the request

Listing: DataServiceVersion Header ABNF Grammar

Example: DataServiceVersion: 1.0;AspNetAjax

If present on a request, the VersionNum section of the header value states the version of the OData protocol that the client used to generate the request, as specified in the preceding DataServiceVersion Header ABNF Grammar listing.

If present on a response, the VersionNum section of the header value states the version of the OData protocol that the server used to generate the response, as specified in the preceding DataServiceVersion Header ABNF Grammar listing.

For additional processing rules for this header, see Versioning and Capability Negotiation (section 1.7).

The VersionClientUserAgent section, as specified in the previous listing in this section, DataServiceVersion Header ABNF GrammarService Operation Parameters, of the header value is not significant, SHOULD NOT be interpreted by a data service, and SHOULD NOT affect the versioning semantics of a data service.

This document defines OData 1.0, OData 2.0, and OData 3.0.