GET api/Surveys/Dispatches?AccessToken={AccessToken}&DispatchDate={DispatchDate}&FormGUID={FormGUID}&Search={Search}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
AccessToken | string |
Required String length: inclusive between 1 and 50 |
|
DispatchDate | string |
Required String length: inclusive between 10 and 19 |
|
FormGUID | string |
None. |
|
Search | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of DispatchName | Description | Type | Additional information |
---|---|---|---|
Title | string |
None. |
|
GUID | string |
None. |
|
ID | string |
None. |
|
LocationName | string |
None. |
|
Consecutive | string |
None. |
|
AssetName | string |
None. |
|
ParentGUID | string |
None. |
|
AssetConsecutive | string |
None. |
|
ExternalID | string |
None. |
|
AssignedToName | string |
None. |
|
AssignedToapiRef1 | string |
None. |
|
AssignedToapiRef2 | string |
None. |
|
AssignedToapiRef3 | string |
None. |
|
CompanyStatusID | string |
None. |
|
CompanyStatusName | string |
None. |
|
CompanyStatusGUID | string |
None. |
|
DispatchDateTime | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Title": "sample string 1", "GUID": "sample string 2", "ID": "sample string 3", "LocationName": "sample string 4", "Consecutive": "sample string 5", "AssetName": "sample string 6", "ParentGUID": "sample string 7", "AssetConsecutive": "sample string 8", "ExternalID": "sample string 9", "AssignedToName": "sample string 10", "AssignedToapiRef1": "sample string 11", "AssignedToapiRef2": "sample string 12", "AssignedToapiRef3": "sample string 13", "CompanyStatusID": "sample string 14", "CompanyStatusName": "sample string 15", "CompanyStatusGUID": "sample string 16", "DispatchDateTime": "sample string 17" }, { "Title": "sample string 1", "GUID": "sample string 2", "ID": "sample string 3", "LocationName": "sample string 4", "Consecutive": "sample string 5", "AssetName": "sample string 6", "ParentGUID": "sample string 7", "AssetConsecutive": "sample string 8", "ExternalID": "sample string 9", "AssignedToName": "sample string 10", "AssignedToapiRef1": "sample string 11", "AssignedToapiRef2": "sample string 12", "AssignedToapiRef3": "sample string 13", "CompanyStatusID": "sample string 14", "CompanyStatusName": "sample string 15", "CompanyStatusGUID": "sample string 16", "DispatchDateTime": "sample string 17" } ]
application/octet-stream
Sample:
[{"Title":"sample string 1","GUID":"sample string 2","ID":"sample string 3","LocationName":"sample string 4","Consecutive":"sample string 5","AssetName":"sample string 6","ParentGUID":"sample string 7","AssetConsecutive":"sample string 8","ExternalID":"sample string 9","AssignedToName":"sample string 10","AssignedToapiRef1":"sample string 11","AssignedToapiRef2":"sample string 12","AssignedToapiRef3":"sample string 13","CompanyStatusID":"sample string 14","CompanyStatusName":"sample string 15","CompanyStatusGUID":"sample string 16","DispatchDateTime":"sample string 17"},{"Title":"sample string 1","GUID":"sample string 2","ID":"sample string 3","LocationName":"sample string 4","Consecutive":"sample string 5","AssetName":"sample string 6","ParentGUID":"sample string 7","AssetConsecutive":"sample string 8","ExternalID":"sample string 9","AssignedToName":"sample string 10","AssignedToapiRef1":"sample string 11","AssignedToapiRef2":"sample string 12","AssignedToapiRef3":"sample string 13","CompanyStatusID":"sample string 14","CompanyStatusName":"sample string 15","CompanyStatusGUID":"sample string 16","DispatchDateTime":"sample string 17"}]
application/xml, text/xml
Sample:
<ArrayOfDispatch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Dispatch> <Title>sample string 1</Title> <GUID>sample string 2</GUID> <ID>sample string 3</ID> <LocationName>sample string 4</LocationName> <Consecutive>sample string 5</Consecutive> <AssetName>sample string 6</AssetName> <ParentGUID>sample string 7</ParentGUID> <AssetConsecutive>sample string 8</AssetConsecutive> <ExternalID>sample string 9</ExternalID> <AssignedToName>sample string 10</AssignedToName> <AssignedToapiRef1>sample string 11</AssignedToapiRef1> <AssignedToapiRef2>sample string 12</AssignedToapiRef2> <AssignedToapiRef3>sample string 13</AssignedToapiRef3> <CompanyStatusID>sample string 14</CompanyStatusID> <CompanyStatusName>sample string 15</CompanyStatusName> <CompanyStatusGUID>sample string 16</CompanyStatusGUID> <DispatchDateTime>sample string 17</DispatchDateTime> </Dispatch> <Dispatch> <Title>sample string 1</Title> <GUID>sample string 2</GUID> <ID>sample string 3</ID> <LocationName>sample string 4</LocationName> <Consecutive>sample string 5</Consecutive> <AssetName>sample string 6</AssetName> <ParentGUID>sample string 7</ParentGUID> <AssetConsecutive>sample string 8</AssetConsecutive> <ExternalID>sample string 9</ExternalID> <AssignedToName>sample string 10</AssignedToName> <AssignedToapiRef1>sample string 11</AssignedToapiRef1> <AssignedToapiRef2>sample string 12</AssignedToapiRef2> <AssignedToapiRef3>sample string 13</AssignedToapiRef3> <CompanyStatusID>sample string 14</CompanyStatusID> <CompanyStatusName>sample string 15</CompanyStatusName> <CompanyStatusGUID>sample string 16</CompanyStatusGUID> <DispatchDateTime>sample string 17</DispatchDateTime> </Dispatch> </ArrayOfDispatch>