GET api/classifications/activesubstancedescription?code={code}&model={model}

Active Substance Description Lookup

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

ActiveSubstanceDescriptionResponseModel

Name	Type	Additional information
ActiveSubstanceDescription	ActiveSubstanceDescriptionModel	None.
DataError	DataError	None.
IsDemoData	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ActiveSubstanceDescription": {
    "Code": "sample string 1",
    "ClassCode": "sample string 2",
    "DrugClass": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Description": "sample string 3",
    "ProductCodeList": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "DataError": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "IsDemoData": true
}

application/xml, text/xml

Sample:

<ActiveSubstanceDescriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.ResponseModels.MedpraxMedMat">
  <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>
  <ActiveSubstanceDescription xmlns:d2p1="http://schemas.datacontract.org/2004/07/Medprax.WebAPI.Models.Models.MedpraxMedMat">
    <d2p1:ClassCode>sample string 2</d2p1:ClassCode>
    <d2p1:Code>sample string 1</d2p1:Code>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DrugClass>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
    </d2p1:DrugClass>
    <d2p1:ProductCodeList 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:ProductCodeList>
  </ActiveSubstanceDescription>
</ActiveSubstanceDescriptionResponseModel>