GET api/schemes/formulary/list?nappiCodeFirstSixDigits={nappiCodeFirstSixDigits}&model={model}

Get the Formularies for a Plan SubOption

Request Information

URI Parameters

Name	Description	Type	Additional information
nappiCodeFirstSixDigits		string	Required
model	Include the related model hierarchy	boolean	Required

Body Parameters

None.

Response Information

Resource Description

FormulariesResponseModel

Name	Type	Additional information
Formularies	PaginationListModelOfFormularyModel	None.
DataError	DataError	None.
IsDemoData	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Formularies": {
    "HasPreviousPage": true,
    "HasNextPage": true,
    "PageIndex": 3,
    "PageSize": 4,
    "TotalPages": 5,
    "TotalCount": 6,
    "ThisCount": 7,
    "PageResult": [
      {
        "NappiCodeFirstSixDigits": "sample string 1",
        "FormularyCodeCode": "sample string 2",
        "FormularyCode": {
          "Code": "sample string 1",
          "Description": "sample string 2"
        }
      },
      {
        "NappiCodeFirstSixDigits": "sample string 1",
        "FormularyCodeCode": "sample string 2",
        "FormularyCode": {
          "Code": "sample string 1",
          "Description": "sample string 2"
        }
      }
    ]
  },
  "DataError": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "IsDemoData": true
}

application/xml, text/xml

Sample:

<FormulariesResponseModel 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>
  <Formularies xmlns:d2p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models">
    <d2p1:HasNextPage>true</d2p1:HasNextPage>
    <d2p1:HasPreviousPage>true</d2p1:HasPreviousPage>
    <d2p1:PageIndex>3</d2p1:PageIndex>
    <d2p1:PageResult xmlns:d3p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.Models.MedpraxMedMat">
      <d3p1:FormularyModel>
        <d3p1:FormularyCode>
          <d3p1:Code>sample string 1</d3p1:Code>
          <d3p1:Description>sample string 2</d3p1:Description>
        </d3p1:FormularyCode>
        <d3p1:FormularyCodeCode>sample string 2</d3p1:FormularyCodeCode>
        <d3p1:NappiCodeFirstSixDigits>sample string 1</d3p1:NappiCodeFirstSixDigits>
      </d3p1:FormularyModel>
      <d3p1:FormularyModel>
        <d3p1:FormularyCode>
          <d3p1:Code>sample string 1</d3p1:Code>
          <d3p1:Description>sample string 2</d3p1:Description>
        </d3p1:FormularyCode>
        <d3p1:FormularyCodeCode>sample string 2</d3p1:FormularyCodeCode>
        <d3p1:NappiCodeFirstSixDigits>sample string 1</d3p1:NappiCodeFirstSixDigits>
      </d3p1:FormularyModel>
    </d2p1:PageResult>
    <d2p1:PageSize>4</d2p1:PageSize>
    <d2p1:ThisCount>7</d2p1:ThisCount>
    <d2p1:TotalCount>6</d2p1:TotalCount>
    <d2p1:TotalPages>5</d2p1:TotalPages>
  </Formularies>
</FormulariesResponseModel>