LogoLogo
WebsiteGitHubSlack
Common v1.0.0
Common v1.0.0
  • Digital Convergence Initiative (DCI)
    • About DCI
    • DCI Objective
    • Terminology
    • Acronyms
    • Licensing
  • Standards for Interoperability Interfaces
    • Structure & Versioning of the Standards
    • Naming Conventions
    • Common Assumptions
    • Common Exception Handling
    • Common Standards for Interoperability Interfaces
      • Process
        • PRS.COM.01 Standards Creation
      • Data
        • File Type: JSON-LD
        • Data Objects
          • DO.COM.01 Identifier
          • DO.COM.02 Name
          • DO.COM.03 Address
          • DO.COM.04 GeoLocation
          • DO.COM.05 GooglePlusCode
          • DO.COM.06 GeoShape
          • DO.COM.07 Place
        • Code Directory
          • CD.COM.01 identifier_type
          • CD.COM.02 marital_status
          • CD.COM.03 sex
          • CD.COM.04 vital_event
          • CD.COM.05 country
          • CD.COM.06 currency
          • CD.COM.07 relationship_type
          • CD.COM.08 ethnicity
          • CD.COM.09 nationality
          • CD.COM.10: functional_limitation _type
          • CD.COM.11: functional_limitations_level
          • CD.COM.12: payment_status
          • CD.COM.13: group_type
          • CD.COM.14: language_code
          • CD.COM.15: education_level
          • API specific
            • CD.COM.API.01 api_error_codes_common
            • CD.COM.API.02 api_error_codes_search_on_search
            • CD.COM.API.03 api_error_codes_subscribe_unsubscribe
            • CD.COM.API.04 api_error_codes_status_on_status
        • Data Types and Formats
          • DT.COM.01 object
          • DT.COM.02 string
            • Data Formats
              • DF.COM.STRING.01 date_time
              • DF.COM.STRING.02 phone_number
              • DF.COM.STRING.03 distance
              • DF.COM.STRING.04 country_code
              • DF.COM.STRING.05 geo_line
              • DF.COM.STRING.06 polygon
              • DF.COM.STRING.07 email
              • DF.COM.STRING.08 currency
          • DT.COM.03 integer
          • DT.COM.04 decimal
          • DT.COM.05 array
          • DT.COM.06 boolean
        • Data Governance
      • API
        • Design Principles
        • Versioning
        • Methods
          • API.COM.01.ASY Search (Async approach)
          • API.COM.01.SYN Search (Sync approach)
          • API.COM.02 Event Subscription
          • API.COM.03 Event Notification
          • API.COM.04.ASY Status (Async approach)
          • API.COM.04.SYN Status (Sync approach)
    • CRVS with SP-MIS Standards
    • Social Registry v1.0.0
    • Integrated Beneficiary Registry v1.0.0
    • Disability Registry v1.0.0.
    • Farmer Registry v1.0.0.
  • Resources
    • Website
    • GitHub
    • API Documentation
    • Discussion Forum
    • Guide Book
    • References
Powered by GitBook
On this page
  • API Versioning
  • Schema Objects Versioning

Was this helpful?

  1. Standards for Interoperability Interfaces
  2. Common Standards for Interoperability Interfaces
  3. API

Versioning

Details of API versioning

Last updated 2 months ago

Was this helpful?

API Versioning

The API request contains header data. The version component of the header object represents the version of the API.

Schema Objects Versioning

The 'version' attribute in the search request represents the schema object version of the object being sent. It indicates the specific version of the object that is included in the search request. For example, the following request SearchRequestObject in the data attribute and version attribute to indicate SearchRequestObject's version.

Note: The version attribute is being added to various APIs (work in progress).