GET api/schemes/scheme/all

Scheme Lookup - Returns all the Schemes

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SchemeLimitedResponseModel
NameDescriptionTypeAdditional information
Schemes

Collection of SchemeLimitedModel

None.

DataError

DataError

None.

IsDemoData

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Schemes": [
    {
      "Name": "sample string 1",
      "Code": "sample string 2",
      "SchemeAdministratorCode": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Code": "sample string 2",
      "SchemeAdministratorCode": "sample string 3"
    }
  ],
  "DataError": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "IsDemoData": true
}

application/xml, text/xml

Sample:
<SchemeLimitedResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.ResponseModels.MedpraxScheme">
  <DataError xmlns:d2p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.Error" xmlns="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.ResponseModels">
    <d2p1:Code>1</d2p1:Code>
    <d2p1:Message>sample string 2</d2p1:Message>
  </DataError>
  <IsDemoData xmlns="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.ResponseModels">true</IsDemoData>
  <Schemes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.Models.MedpraxScheme">
    <d2p1:SchemeLimitedModel>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:SchemeAdministratorCode>sample string 3</d2p1:SchemeAdministratorCode>
    </d2p1:SchemeLimitedModel>
    <d2p1:SchemeLimitedModel>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:SchemeAdministratorCode>sample string 3</d2p1:SchemeAdministratorCode>
    </d2p1:SchemeLimitedModel>
  </Schemes>
</SchemeLimitedResponseModel>