GET DispatchDevice/GetDispatchDevice?dispatchType={dispatchType}

Returns a list of Dispatch devices by Dispatch type.

Request Information

URI Parameters

Name	Description	Type	Additional Information
dispatchType	The Dispatch type to be returned. Default is All Types (optional)	DispatchTypes	Default value is All

Body Parameters

Response Information

Resource Description

Returns a list of Dispatch devices by Dispatch type.

AgvDispatchDevice

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
Count	Number of results returned.	string
DispatchDevices	List of Properties and Values returned for each device that matches the request.	Collection of ClsDispatchDevice

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "DispatchDevices": [
    {
      "DispatchDeviceGUID": "bb34b51e-fbdc-45fb-a34a-311fdbed63ec",
      "DeviceID": "sample string 2",
      "DispatchType": "sample string 3",
      "ApplicatorDriverID": "sample string 4",
      "VehicleID": "sample string 5",
      "UserID": "sample string 6",
      "Alias": "sample string 10",
      "EMail": "sample string 11",
      "OperatingSystemType": "sample string 12",
      "DeviceToken": "sample string 13",
      "DeviceVerNum": "sample string 14",
      "AllowEditTicket": true,
      "AllowRecordConditions": true,
      "UserFirstName": "sample string 17",
      "UserLastName": "sample string 18",
      "ApplicatorFirstName": "sample string 19",
      "ApplicatorLastName": "sample string 20",
      "VehicleDescription": "sample string 21"
    },
    {
      "DispatchDeviceGUID": "bb34b51e-fbdc-45fb-a34a-311fdbed63ec",
      "DeviceID": "sample string 2",
      "DispatchType": "sample string 3",
      "ApplicatorDriverID": "sample string 4",
      "VehicleID": "sample string 5",
      "UserID": "sample string 6",
      "Alias": "sample string 10",
      "EMail": "sample string 11",
      "OperatingSystemType": "sample string 12",
      "DeviceToken": "sample string 13",
      "DeviceVerNum": "sample string 14",
      "AllowEditTicket": true,
      "AllowRecordConditions": true,
      "UserFirstName": "sample string 17",
      "UserLastName": "sample string 18",
      "ApplicatorFirstName": "sample string 19",
      "ApplicatorLastName": "sample string 20",
      "VehicleDescription": "sample string 21"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvDispatchDevice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Dispatch">
  <DispatchDevices xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Dispatch">
    <d2p1:DispatchDevice>
      <d2p1:Alias>sample string 10</d2p1:Alias>
      <d2p1:AllowEditTicket>true</d2p1:AllowEditTicket>
      <d2p1:AllowRecordConditions>true</d2p1:AllowRecordConditions>
      <d2p1:ApplicatorDriverID>sample string 4</d2p1:ApplicatorDriverID>
      <d2p1:ApplicatorFirstName>sample string 19</d2p1:ApplicatorFirstName>
      <d2p1:ApplicatorLastName>sample string 20</d2p1:ApplicatorLastName>
      <d2p1:DeviceID>sample string 2</d2p1:DeviceID>
      <d2p1:DeviceToken>sample string 13</d2p1:DeviceToken>
      <d2p1:DeviceVerNum>sample string 14</d2p1:DeviceVerNum>
      <d2p1:DispatchDeviceGUID>bb34b51e-fbdc-45fb-a34a-311fdbed63ec</d2p1:DispatchDeviceGUID>
      <d2p1:DispatchType>sample string 3</d2p1:DispatchType>
      <d2p1:EMail>sample string 11</d2p1:EMail>
      <d2p1:OperatingSystemType>sample string 12</d2p1:OperatingSystemType>
      <d2p1:UserFirstName>sample string 17</d2p1:UserFirstName>
      <d2p1:UserID>sample string 6</d2p1:UserID>
      <d2p1:UserLastName>sample string 18</d2p1:UserLastName>
      <d2p1:VehicleDescription>sample string 21</d2p1:VehicleDescription>
      <d2p1:VehicleID>sample string 5</d2p1:VehicleID>
    </d2p1:DispatchDevice>
    <d2p1:DispatchDevice>
      <d2p1:Alias>sample string 10</d2p1:Alias>
      <d2p1:AllowEditTicket>true</d2p1:AllowEditTicket>
      <d2p1:AllowRecordConditions>true</d2p1:AllowRecordConditions>
      <d2p1:ApplicatorDriverID>sample string 4</d2p1:ApplicatorDriverID>
      <d2p1:ApplicatorFirstName>sample string 19</d2p1:ApplicatorFirstName>
      <d2p1:ApplicatorLastName>sample string 20</d2p1:ApplicatorLastName>
      <d2p1:DeviceID>sample string 2</d2p1:DeviceID>
      <d2p1:DeviceToken>sample string 13</d2p1:DeviceToken>
      <d2p1:DeviceVerNum>sample string 14</d2p1:DeviceVerNum>
      <d2p1:DispatchDeviceGUID>bb34b51e-fbdc-45fb-a34a-311fdbed63ec</d2p1:DispatchDeviceGUID>
      <d2p1:DispatchType>sample string 3</d2p1:DispatchType>
      <d2p1:EMail>sample string 11</d2p1:EMail>
      <d2p1:OperatingSystemType>sample string 12</d2p1:OperatingSystemType>
      <d2p1:UserFirstName>sample string 17</d2p1:UserFirstName>
      <d2p1:UserID>sample string 6</d2p1:UserID>
      <d2p1:UserLastName>sample string 18</d2p1:UserLastName>
      <d2p1:VehicleDescription>sample string 21</d2p1:VehicleDescription>
      <d2p1:VehicleID>sample string 5</d2p1:VehicleID>
    </d2p1:DispatchDevice>
  </DispatchDevices>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvDispatchDevice>