NHS eClass API

There is a basic RESTful API available to access eClass data.

Root URL: https://nhs-eclass.azurewebsites.net/api/v1.0/nhs-eClass

eClass Versions

• /versions
  • Try it
  • Retrieve all eClass versions.
• /versions/current
  • Try it
  • Retrieve the latest version of eClass.
• /versions/{version}
  • Try it
  • Retrieve the version of eClass with version = {version}.

eClass Codes

• /codes
  • Try it
  • Returns all versions of eClass with all codes.
  • Params
    • ?version= Retrieve a single version Example
    • ?tier= Retrieve a tier (1-3), e.g. 1 will return all single-character eClass codes Example
    • ?includeChildren=true Retrieve hierarchy of child codes Example
    • Combine these tags and you can build a hierarchy Example
• /codes/current
  • Try it
  • As above but only the current version.
  • Params
    • ?tier= Retrieve a tier (1-3), e.g. 1 will return all single-character eClass codes Example
    • ?includeChildren=true Retrieve hierarchy of child codes Example
• codes/{id}
  • Try it
  • Retrieves all codes matching the given ID from all versions of eClass.
  • Params
    • ?version= Retrieve a particular version Example
    • ?includeChildren=true Retrieve hierarchy of child codes Example
• codes/current/{id}
  • Try it
  • Retrieves the latest version of the given code.
  • Params
    • ?includeChildren=true Retrieve hierarchy of child codes Example
• codes/previous/{id}
  • Try it
  • Retrieves all previous versions of the given code, but not the current version.
  • Params
    • ?includeChildren=true Retrieve hierarchy of child codes Example