GET api/schemes/scheme?code={code}&model={model}

Scheme Lookup

Request Information

URI Parameters

Name	Description	Type	Additional information
code	Medprax Scheme Code	string	Required
model	Include the related model hierarchy	boolean	Required

Body Parameters

None.

Response Information

Resource Description

SchemeResponseModel

Name	Type	Additional information
Scheme	SchemeModel	None.
DataError	DataError	None.
IsDemoData	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Scheme": {
    "DateFormat": "sample string 1",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "SchemeAdministrator": {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "DiscontinuedDate": "2025-12-11T17:28:05.4547686+02:00",
      "SchemeCodeList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SchemeAdministratorCode": "sample string 4",
    "ManagedCareCompany": {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "TollFree": "sample string 3",
      "TelephoneNumber": "sample string 4",
      "FaxNumber": "sample string 5",
      "Email": "sample string 6",
      "Url": "sample string 7"
    },
    "ManagedCareCompanyCode": "sample string 5",
    "CaptitionScheme": "sample string 6",
    "DiscontinuedDate": "sample string 7",
    "CmsReferenceNumber": "sample string 8",
    "Category": "sample string 9",
    "SchemeTelephoneNumber": "sample string 10",
    "SchemeEmail": "sample string 11",
    "SchemeUrl": "sample string 12",
    "PlanCodeList": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "DataError": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "IsDemoData": true
}

application/xml, text/xml

Sample:

<SchemeResponseModel 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>
  <Scheme xmlns:d2p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.Models.MedpraxScheme">
    <d2p1:CaptitionScheme>sample string 6</d2p1:CaptitionScheme>
    <d2p1:Category>sample string 9</d2p1:Category>
    <d2p1:CmsReferenceNumber>sample string 8</d2p1:CmsReferenceNumber>
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:DateFormat>sample string 1</d2p1:DateFormat>
    <d2p1:DiscontinuedDate>sample string 7</d2p1:DiscontinuedDate>
    <d2p1:ManagedCareCompany>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Email>sample string 6</d2p1:Email>
      <d2p1:FaxNumber>sample string 5</d2p1:FaxNumber>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:TelephoneNumber>sample string 4</d2p1:TelephoneNumber>
      <d2p1:TollFree>sample string 3</d2p1:TollFree>
      <d2p1:Url>sample string 7</d2p1:Url>
    </d2p1:ManagedCareCompany>
    <d2p1:ManagedCareCompanyCode>sample string 5</d2p1:ManagedCareCompanyCode>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:PlanCodeList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:PlanCodeList>
    <d2p1:SchemeAdministrator>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:DiscontinuedDate>2025-12-11T17:28:05.4547686+02:00</d2p1:DiscontinuedDate>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SchemeCodeList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:SchemeCodeList>
    </d2p1:SchemeAdministrator>
    <d2p1:SchemeAdministratorCode>sample string 4</d2p1:SchemeAdministratorCode>
    <d2p1:SchemeEmail>sample string 11</d2p1:SchemeEmail>
    <d2p1:SchemeTelephoneNumber>sample string 10</d2p1:SchemeTelephoneNumber>
    <d2p1:SchemeUrl>sample string 12</d2p1:SchemeUrl>
  </Scheme>
</SchemeResponseModel>