POST Offsite/GetOrders
Return Orders for this user
Request Information
URI Parameters
None.
Body Parameters
Array of statuses
StatusListName | Description | Type | Additional information |
---|---|---|---|
Statuses | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Statuses": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<StatusList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Offsite"> <Statuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Statuses> </StatusList>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of OrderModelName | Description | Type | Additional information |
---|---|---|---|
Id |
OrderId |
integer |
None. |
Status |
Order Status |
string |
None. |
Date |
Order Date |
date |
None. |
Address1 |
Street Address 1 |
string |
None. |
Address2 |
Street Address 2 |
string |
None. |
City |
City |
string |
None. |
State |
State |
string |
None. |
Zip |
Zip Code |
string |
None. |
Panels |
Services / Panels |
Collection of PanelModel |
None. |
Distance |
Distance from Home in miles |
decimal number |
None. |
ScheduledTime |
Scheduled Time |
integer |
None. |
PatientPhone |
Patient Phone |
string |
None. |
CaseManagerMobilePhone |
Contact Mobile Phone |
string |
None. |
CaseManagerDirectPhone | string |
None. |
|
CaseManagerEmail |
Contact Email |
string |
None. |
StartAddress1 |
StartAddress1 |
string |
None. |
StartAddress2 |
StartAddress2 |
string |
None. |
StartCity |
StartCity |
string |
None. |
StartState |
StartState |
string |
None. |
StartZip |
StartZip |
string |
None. |
OdometerStart |
OdometerStart |
integer |
None. |
OdometerEnd |
OdometerEnd |
integer |
None. |
Latitude |
Latitude |
decimal number |
None. |
Longitude |
Longitude |
decimal number |
None. |
Patients |
Patients in this Order |
Collection of PatientModel |
None. |
AvailibilityHours |
Availibility |
Collection of integer |
None. |
Phone |
Patient Phone |
string |
None. |
Agency |
Agency - Third Party or Averhealth |
string |
None. |
ShippingLabel |
Tracking # |
string |
None. |
EmployeeId | integer |
None. |
|
ContactId | integer |
None. |
|
OnewayMileage | integer |
None. |
|
AccountId | integer |
None. |
|
AgencyName |
Third Party Agency Name |
string |
None. |
HasCollectionAddress | boolean |
None. |
|
DontShowBefore | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "Status": "sample string 2", "Date": "2024-11-14T15:02:06.1646132+00:00", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Panels": [ { "Id": 1, "OffsiteOrderId": 1, "CollectionType": "sample string 2", "Status": "sample string 3", "CollectionId": 1, "Barcode": "sample string 4", "Result": "sample string 5", "Reason": "sample string 6", "IsCustomPanel": true, "ShippingLabel": "sample string 8", "First": "sample string 9", "Last": "sample string 10" }, { "Id": 1, "OffsiteOrderId": 1, "CollectionType": "sample string 2", "Status": "sample string 3", "CollectionId": 1, "Barcode": "sample string 4", "Result": "sample string 5", "Reason": "sample string 6", "IsCustomPanel": true, "ShippingLabel": "sample string 8", "First": "sample string 9", "Last": "sample string 10" } ], "Distance": 1.1, "ScheduledTime": 1, "PatientPhone": "sample string 8", "CaseManagerMobilePhone": "sample string 9", "CaseManagerDirectPhone": "sample string 10", "CaseManagerEmail": "sample string 11", "StartAddress1": "sample string 12", "StartAddress2": "sample string 13", "StartCity": "sample string 14", "StartState": "sample string 15", "StartZip": "sample string 16", "OdometerStart": 1, "OdometerEnd": 1, "Latitude": 1.1, "Longitude": 1.1, "Patients": [ { "CollectionId": 1, "DonorId": 1, "First": "sample string 2", "Last": "sample string 3", "Gender": "sample string 4", "OffsiteOrderId": 1, "Birthdate": "2024-11-14T15:02:06.1656129+00:00" }, { "CollectionId": 1, "DonorId": 1, "First": "sample string 2", "Last": "sample string 3", "Gender": "sample string 4", "OffsiteOrderId": 1, "Birthdate": "2024-11-14T15:02:06.1656129+00:00" } ], "AvailibilityHours": [ 1, 2 ], "Phone": "sample string 17", "Agency": "sample string 18", "ShippingLabel": "sample string 19", "EmployeeId": 1, "ContactId": 1, "OnewayMileage": 1, "AccountId": 1, "AgencyName": "sample string 20", "HasCollectionAddress": true, "DontShowBefore": "2024-11-14T15:02:06.1656129+00:00" }, { "Id": 1, "Status": "sample string 2", "Date": "2024-11-14T15:02:06.1646132+00:00", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Panels": [ { "Id": 1, "OffsiteOrderId": 1, "CollectionType": "sample string 2", "Status": "sample string 3", "CollectionId": 1, "Barcode": "sample string 4", "Result": "sample string 5", "Reason": "sample string 6", "IsCustomPanel": true, "ShippingLabel": "sample string 8", "First": "sample string 9", "Last": "sample string 10" }, { "Id": 1, "OffsiteOrderId": 1, "CollectionType": "sample string 2", "Status": "sample string 3", "CollectionId": 1, "Barcode": "sample string 4", "Result": "sample string 5", "Reason": "sample string 6", "IsCustomPanel": true, "ShippingLabel": "sample string 8", "First": "sample string 9", "Last": "sample string 10" } ], "Distance": 1.1, "ScheduledTime": 1, "PatientPhone": "sample string 8", "CaseManagerMobilePhone": "sample string 9", "CaseManagerDirectPhone": "sample string 10", "CaseManagerEmail": "sample string 11", "StartAddress1": "sample string 12", "StartAddress2": "sample string 13", "StartCity": "sample string 14", "StartState": "sample string 15", "StartZip": "sample string 16", "OdometerStart": 1, "OdometerEnd": 1, "Latitude": 1.1, "Longitude": 1.1, "Patients": [ { "CollectionId": 1, "DonorId": 1, "First": "sample string 2", "Last": "sample string 3", "Gender": "sample string 4", "OffsiteOrderId": 1, "Birthdate": "2024-11-14T15:02:06.1656129+00:00" }, { "CollectionId": 1, "DonorId": 1, "First": "sample string 2", "Last": "sample string 3", "Gender": "sample string 4", "OffsiteOrderId": 1, "Birthdate": "2024-11-14T15:02:06.1656129+00:00" } ], "AvailibilityHours": [ 1, 2 ], "Phone": "sample string 17", "Agency": "sample string 18", "ShippingLabel": "sample string 19", "EmployeeId": 1, "ContactId": 1, "OnewayMileage": 1, "AccountId": 1, "AgencyName": "sample string 20", "HasCollectionAddress": true, "DontShowBefore": "2024-11-14T15:02:06.1656129+00:00" } ]
application/xml, text/xml
Sample:
<ArrayOfOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Offsite"> <OrderModel> <AccountId>1</AccountId> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <Agency>sample string 18</Agency> <AgencyName>sample string 20</AgencyName> <AvailibilityHours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </AvailibilityHours> <CaseManagerDirectPhone>sample string 10</CaseManagerDirectPhone> <CaseManagerEmail>sample string 11</CaseManagerEmail> <CaseManagerMobilePhone>sample string 9</CaseManagerMobilePhone> <City>sample string 5</City> <ContactId>1</ContactId> <Date>2024-11-14T15:02:06.1646132+00:00</Date> <Distance>1.1</Distance> <EmployeeId>1</EmployeeId> <Id>1</Id> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> <OdometerEnd>1</OdometerEnd> <OdometerStart>1</OdometerStart> <OnewayMileage>1</OnewayMileage> <Panels> <PanelModel> <Barcode>sample string 4</Barcode> <CollectionId>1</CollectionId> <CollectionType>sample string 2</CollectionType> <First>sample string 9</First> <Id>1</Id> <IsCustomPanel>true</IsCustomPanel> <Last>sample string 10</Last> <OffsiteOrderId>1</OffsiteOrderId> <Reason>sample string 6</Reason> <Result>sample string 5</Result> <ShippingLabel>sample string 8</ShippingLabel> <Status>sample string 3</Status> </PanelModel> <PanelModel> <Barcode>sample string 4</Barcode> <CollectionId>1</CollectionId> <CollectionType>sample string 2</CollectionType> <First>sample string 9</First> <Id>1</Id> <IsCustomPanel>true</IsCustomPanel> <Last>sample string 10</Last> <OffsiteOrderId>1</OffsiteOrderId> <Reason>sample string 6</Reason> <Result>sample string 5</Result> <ShippingLabel>sample string 8</ShippingLabel> <Status>sample string 3</Status> </PanelModel> </Panels> <PatientPhone>sample string 8</PatientPhone> <Patients> <PatientModel> <Birthdate>2024-11-14T15:02:06.1656129+00:00</Birthdate> <CollectionId>1</CollectionId> <DonorId>1</DonorId> <First>sample string 2</First> <Gender>sample string 4</Gender> <Last>sample string 3</Last> <OffsiteOrderId>1</OffsiteOrderId> </PatientModel> <PatientModel> <Birthdate>2024-11-14T15:02:06.1656129+00:00</Birthdate> <CollectionId>1</CollectionId> <DonorId>1</DonorId> <First>sample string 2</First> <Gender>sample string 4</Gender> <Last>sample string 3</Last> <OffsiteOrderId>1</OffsiteOrderId> </PatientModel> </Patients> <Phone>sample string 17</Phone> <ScheduledTime>1</ScheduledTime> <ShippingLabel>sample string 19</ShippingLabel> <StartAddress1>sample string 12</StartAddress1> <StartAddress2>sample string 13</StartAddress2> <StartCity>sample string 14</StartCity> <StartState>sample string 15</StartState> <StartZip>sample string 16</StartZip> <State>sample string 6</State> <Status>sample string 2</Status> <Zip>sample string 7</Zip> </OrderModel> <OrderModel> <AccountId>1</AccountId> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <Agency>sample string 18</Agency> <AgencyName>sample string 20</AgencyName> <AvailibilityHours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </AvailibilityHours> <CaseManagerDirectPhone>sample string 10</CaseManagerDirectPhone> <CaseManagerEmail>sample string 11</CaseManagerEmail> <CaseManagerMobilePhone>sample string 9</CaseManagerMobilePhone> <City>sample string 5</City> <ContactId>1</ContactId> <Date>2024-11-14T15:02:06.1646132+00:00</Date> <Distance>1.1</Distance> <EmployeeId>1</EmployeeId> <Id>1</Id> <Latitude>1.1</Latitude> <Longitude>1.1</Longitude> <OdometerEnd>1</OdometerEnd> <OdometerStart>1</OdometerStart> <OnewayMileage>1</OnewayMileage> <Panels> <PanelModel> <Barcode>sample string 4</Barcode> <CollectionId>1</CollectionId> <CollectionType>sample string 2</CollectionType> <First>sample string 9</First> <Id>1</Id> <IsCustomPanel>true</IsCustomPanel> <Last>sample string 10</Last> <OffsiteOrderId>1</OffsiteOrderId> <Reason>sample string 6</Reason> <Result>sample string 5</Result> <ShippingLabel>sample string 8</ShippingLabel> <Status>sample string 3</Status> </PanelModel> <PanelModel> <Barcode>sample string 4</Barcode> <CollectionId>1</CollectionId> <CollectionType>sample string 2</CollectionType> <First>sample string 9</First> <Id>1</Id> <IsCustomPanel>true</IsCustomPanel> <Last>sample string 10</Last> <OffsiteOrderId>1</OffsiteOrderId> <Reason>sample string 6</Reason> <Result>sample string 5</Result> <ShippingLabel>sample string 8</ShippingLabel> <Status>sample string 3</Status> </PanelModel> </Panels> <PatientPhone>sample string 8</PatientPhone> <Patients> <PatientModel> <Birthdate>2024-11-14T15:02:06.1656129+00:00</Birthdate> <CollectionId>1</CollectionId> <DonorId>1</DonorId> <First>sample string 2</First> <Gender>sample string 4</Gender> <Last>sample string 3</Last> <OffsiteOrderId>1</OffsiteOrderId> </PatientModel> <PatientModel> <Birthdate>2024-11-14T15:02:06.1656129+00:00</Birthdate> <CollectionId>1</CollectionId> <DonorId>1</DonorId> <First>sample string 2</First> <Gender>sample string 4</Gender> <Last>sample string 3</Last> <OffsiteOrderId>1</OffsiteOrderId> </PatientModel> </Patients> <Phone>sample string 17</Phone> <ScheduledTime>1</ScheduledTime> <ShippingLabel>sample string 19</ShippingLabel> <StartAddress1>sample string 12</StartAddress1> <StartAddress2>sample string 13</StartAddress2> <StartCity>sample string 14</StartCity> <StartState>sample string 15</StartState> <StartZip>sample string 16</StartZip> <State>sample string 6</State> <Status>sample string 2</Status> <Zip>sample string 7</Zip> </OrderModel> </ArrayOfOrderModel>