GET api/DrugCompendia/GetPublishedAgents/{accessKey}

Retrieves all agents from published Compendia

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessKey

string

Required

Body Parameters

None.

Response Information

Resource Description

AgentsRequest
NameDescriptionTypeAdditional information
IsValid

Is request valid

boolean

None.

Message

Response message

string

None.

AgentRecords

List of Agents

Collection of Agent

None.

Response Formats

application/json, text/json

Sample:
{
  "IsValid": true,
  "Message": "sample string 2",
  "AgentRecords": [
    {
      "AgentID": 1,
      "AgentDesc": "sample string 2",
      "FDAIndication": "sample string 3",
      "Pharmclass": "sample string 4"
    },
    {
      "AgentID": 1,
      "AgentDesc": "sample string 2",
      "FDAIndication": "sample string 3",
      "Pharmclass": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<AgentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="CompendiumRequest">
  <AgentRecords>
    <Agent>
      <AgentDesc>sample string 2</AgentDesc>
      <AgentID>1</AgentID>
      <FDAIndication>sample string 3</FDAIndication>
      <Pharmclass>sample string 4</Pharmclass>
    </Agent>
    <Agent>
      <AgentDesc>sample string 2</AgentDesc>
      <AgentID>1</AgentID>
      <FDAIndication>sample string 3</FDAIndication>
      <Pharmclass>sample string 4</Pharmclass>
    </Agent>
  </AgentRecords>
  <IsValid>true</IsValid>
  <Message>sample string 2</Message>
</AgentsRequest>