GET api/v1/BulkOrder/GetBulkOrderDetails?BatchID={BatchID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
BatchID

integer

Required

Body Parameters

None.

Response Information

Resource Description

BulkOrders
NameDescriptionTypeAdditional information
MetaData

MetaData

None.

Orders

Collection of BulkOrderDetails

None.

Response Formats

application/json, text/json

Sample:
{
  "MetaData": {
    "OFOrgID": 1,
    "OFAccountID": 2,
    "LabOrgid": 3,
    "LabAccountID": 4,
    "OFUserid": 5,
    "ICDCodes": "sample string 6",
    "CreatedBy": 7,
    "Casetype": "sample string 8",
    "BatchNumber": "sample string 9"
  },
  "Orders": [
    {
      "Shorttype": "sample string 1",
      "OrderStatus": "sample string 2",
      "BatchID": 3,
      "CaseID": 4,
      "VOPatientID": 5,
      "OFAccountID": 6,
      "OFUserID": 7,
      "OFOrgName": "sample string 8",
      "PhysicianName": "sample string 9",
      "CaseType": "sample string 10",
      "firstname": "sample string 11",
      "lastname": "sample string 12",
      "middlename": "sample string 13",
      "Suffix": "sample string 14",
      "gender": "sample string 15",
      "dob": "sample string 16",
      "HomeMobilePhone": "sample string 17",
      "homephone": "sample string 18",
      "workphone": "sample string 19",
      "address1": "sample string 20",
      "city": "sample string 21",
      "state": "sample string 22",
      "zip": "sample string 23",
      "EmailId": "sample string 24",
      "relationship": "sample string 25",
      "Guarantorfirstname": "sample string 26",
      "Guarantorlastname": "sample string 27",
      "Guarantoraddress1": "sample string 28",
      "Guarantorcity": "sample string 29",
      "Guarantorstate": "sample string 30",
      "Guarantorzip": "sample string 31",
      "Guarantorhomephone": "sample string 32",
      "InsuranceInfo": "sample string 33",
      "billTo": "sample string 34",
      "SpecimenDetails": "sample string 35",
      "ExtractionDetails": "sample string 36",
      "collectiondate": "sample string 37",
      "collectiontime": "sample string 38",
      "TestDetails": "sample string 39",
      "AdditionalDataJson": "sample string 40",
      "AdditionalDataJsonForXML": "sample string 41",
      "AdditionalDataXML": "sample string 42",
      "Race": "sample string 43",
      "Ethnicity": "sample string 44",
      "OrderNumber": "sample string 45",
      "DeleteRequisition": true,
      "AOEDetails": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Shorttype": "sample string 1",
      "OrderStatus": "sample string 2",
      "BatchID": 3,
      "CaseID": 4,
      "VOPatientID": 5,
      "OFAccountID": 6,
      "OFUserID": 7,
      "OFOrgName": "sample string 8",
      "PhysicianName": "sample string 9",
      "CaseType": "sample string 10",
      "firstname": "sample string 11",
      "lastname": "sample string 12",
      "middlename": "sample string 13",
      "Suffix": "sample string 14",
      "gender": "sample string 15",
      "dob": "sample string 16",
      "HomeMobilePhone": "sample string 17",
      "homephone": "sample string 18",
      "workphone": "sample string 19",
      "address1": "sample string 20",
      "city": "sample string 21",
      "state": "sample string 22",
      "zip": "sample string 23",
      "EmailId": "sample string 24",
      "relationship": "sample string 25",
      "Guarantorfirstname": "sample string 26",
      "Guarantorlastname": "sample string 27",
      "Guarantoraddress1": "sample string 28",
      "Guarantorcity": "sample string 29",
      "Guarantorstate": "sample string 30",
      "Guarantorzip": "sample string 31",
      "Guarantorhomephone": "sample string 32",
      "InsuranceInfo": "sample string 33",
      "billTo": "sample string 34",
      "SpecimenDetails": "sample string 35",
      "ExtractionDetails": "sample string 36",
      "collectiondate": "sample string 37",
      "collectiontime": "sample string 38",
      "TestDetails": "sample string 39",
      "AdditionalDataJson": "sample string 40",
      "AdditionalDataJsonForXML": "sample string 41",
      "AdditionalDataXML": "sample string 42",
      "Race": "sample string 43",
      "Ethnicity": "sample string 44",
      "OrderNumber": "sample string 45",
      "DeleteRequisition": true,
      "AOEDetails": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<BulkOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VitalOrder_v2_ServerApp.DTO">
  <MetaData>
    <BatchNumber>sample string 9</BatchNumber>
    <Casetype>sample string 8</Casetype>
    <CreatedBy>7</CreatedBy>
    <ICDCodes>sample string 6</ICDCodes>
    <LabAccountID>4</LabAccountID>
    <LabOrgid>3</LabOrgid>
    <OFAccountID>2</OFAccountID>
    <OFOrgID>1</OFOrgID>
    <OFUserid>5</OFUserid>
  </MetaData>
  <Orders>
    <BulkOrderDetails>
      <AOEDetails>
        <AOEDetails>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </AOEDetails>
        <AOEDetails>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </AOEDetails>
      </AOEDetails>
      <AdditionalDataJson>sample string 40</AdditionalDataJson>
      <AdditionalDataJsonForXML>sample string 41</AdditionalDataJsonForXML>
      <AdditionalDataXML>sample string 42</AdditionalDataXML>
      <BatchID>3</BatchID>
      <CaseID>4</CaseID>
      <CaseType>sample string 10</CaseType>
      <DeleteRequisition>true</DeleteRequisition>
      <EmailId>sample string 24</EmailId>
      <Ethnicity>sample string 44</Ethnicity>
      <ExtractionDetails>sample string 36</ExtractionDetails>
      <Guarantoraddress1>sample string 28</Guarantoraddress1>
      <Guarantorcity>sample string 29</Guarantorcity>
      <Guarantorfirstname>sample string 26</Guarantorfirstname>
      <Guarantorhomephone>sample string 32</Guarantorhomephone>
      <Guarantorlastname>sample string 27</Guarantorlastname>
      <Guarantorstate>sample string 30</Guarantorstate>
      <Guarantorzip>sample string 31</Guarantorzip>
      <HomeMobilePhone>sample string 17</HomeMobilePhone>
      <InsuranceInfo>sample string 33</InsuranceInfo>
      <OFAccountID>6</OFAccountID>
      <OFOrgName>sample string 8</OFOrgName>
      <OFUserID>7</OFUserID>
      <OrderNumber>sample string 45</OrderNumber>
      <OrderStatus>sample string 2</OrderStatus>
      <PhysicianName>sample string 9</PhysicianName>
      <Race>sample string 43</Race>
      <Shorttype>sample string 1</Shorttype>
      <SpecimenDetails>sample string 35</SpecimenDetails>
      <Suffix>sample string 14</Suffix>
      <TestDetails>sample string 39</TestDetails>
      <VOPatientID>5</VOPatientID>
      <address1>sample string 20</address1>
      <billTo>sample string 34</billTo>
      <city>sample string 21</city>
      <collectiondate>sample string 37</collectiondate>
      <collectiontime>sample string 38</collectiontime>
      <dob>sample string 16</dob>
      <firstname>sample string 11</firstname>
      <gender>sample string 15</gender>
      <homephone>sample string 18</homephone>
      <lastname>sample string 12</lastname>
      <middlename>sample string 13</middlename>
      <relationship>sample string 25</relationship>
      <state>sample string 22</state>
      <workphone>sample string 19</workphone>
      <zip>sample string 23</zip>
    </BulkOrderDetails>
    <BulkOrderDetails>
      <AOEDetails>
        <AOEDetails>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </AOEDetails>
        <AOEDetails>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </AOEDetails>
      </AOEDetails>
      <AdditionalDataJson>sample string 40</AdditionalDataJson>
      <AdditionalDataJsonForXML>sample string 41</AdditionalDataJsonForXML>
      <AdditionalDataXML>sample string 42</AdditionalDataXML>
      <BatchID>3</BatchID>
      <CaseID>4</CaseID>
      <CaseType>sample string 10</CaseType>
      <DeleteRequisition>true</DeleteRequisition>
      <EmailId>sample string 24</EmailId>
      <Ethnicity>sample string 44</Ethnicity>
      <ExtractionDetails>sample string 36</ExtractionDetails>
      <Guarantoraddress1>sample string 28</Guarantoraddress1>
      <Guarantorcity>sample string 29</Guarantorcity>
      <Guarantorfirstname>sample string 26</Guarantorfirstname>
      <Guarantorhomephone>sample string 32</Guarantorhomephone>
      <Guarantorlastname>sample string 27</Guarantorlastname>
      <Guarantorstate>sample string 30</Guarantorstate>
      <Guarantorzip>sample string 31</Guarantorzip>
      <HomeMobilePhone>sample string 17</HomeMobilePhone>
      <InsuranceInfo>sample string 33</InsuranceInfo>
      <OFAccountID>6</OFAccountID>
      <OFOrgName>sample string 8</OFOrgName>
      <OFUserID>7</OFUserID>
      <OrderNumber>sample string 45</OrderNumber>
      <OrderStatus>sample string 2</OrderStatus>
      <PhysicianName>sample string 9</PhysicianName>
      <Race>sample string 43</Race>
      <Shorttype>sample string 1</Shorttype>
      <SpecimenDetails>sample string 35</SpecimenDetails>
      <Suffix>sample string 14</Suffix>
      <TestDetails>sample string 39</TestDetails>
      <VOPatientID>5</VOPatientID>
      <address1>sample string 20</address1>
      <billTo>sample string 34</billTo>
      <city>sample string 21</city>
      <collectiondate>sample string 37</collectiondate>
      <collectiontime>sample string 38</collectiontime>
      <dob>sample string 16</dob>
      <firstname>sample string 11</firstname>
      <gender>sample string 15</gender>
      <homephone>sample string 18</homephone>
      <lastname>sample string 12</lastname>
      <middlename>sample string 13</middlename>
      <relationship>sample string 25</relationship>
      <state>sample string 22</state>
      <workphone>sample string 19</workphone>
      <zip>sample string 23</zip>
    </BulkOrderDetails>
  </Orders>
</BulkOrders>