PUT DispatchDevice/PutDispatchDevice

Updates a DispatchDevice.

Request Information

URI Parameters

Body Parameters

DispatchDevice object used to update an existing record in the database.

ClsDispatchDeviceUpdate
NameDescriptionTypeAdditional Information
DispatchDeviceGuid

The Globally Unique Identifier of the Dispatch Device

 globally unique identifier

Required

(Hexadecimal 8-4-4-4-12)
DeviceId

The Agvance ID of the Dispatch Device

 string

Max length: 12

Must be filled out and numeric

Must not contain invalid characters which include: . -
DispatchType

The type of Dispatch the device corresponds to. (Valid options are: 'Agronomy' or 'Energy'.)

 string

Required

Max length: 20
ApplicatorDriverId

The Agvance Id of the Applicator Driver

 string

Max length: 6
VehicleId

The Agvance Id of the Vehicle (Agronomy Only)

 string

Max length: 10
UserId

The Agvance Id of the User

 string

Max length: 3
Alias

An Alternate Description for the Device

 string

Max length: 25
EMail

The Email Address for the Device (Agronomy Only)

 string

Max length: 50
OperatingSystemType

The Type of Operating System on the Device (Valid options are: 'iOS', 'Android', and ''.)

 string

Max length: 50
DeviceToken

The Identifier Used for Push Notifications

 string

Max length: 255
DeviceVerNum

The Version Number of the Application on the Device

 string

Max length: 20
AllowEditTicket

Indicates whether or not the device is allowed to edit tickets. (Agronomy Only)

 boolean

Must be 0, 1, True, or False
AllowRecordConditions

Indicates whether or not the device is allowed to record Field conditions. (Agronomy Only)

 boolean

Must be 0, 1, True, or False

Request Formats

application/json, text/json

Sample: 
{
  "DispatchDeviceGuid": "1975f139-6f72-4e3c-8de0-d0c2b9db8a70",
  "DeviceId": "sample string 2",
  "DispatchType": "sample string 3",
  "ApplicatorDriverId": "sample string 4",
  "VehicleId": "sample string 5",
  "UserId": "sample string 6",
  "Alias": "sample string 7",
  "EMail": "sample string 8",
  "OperatingSystemType": "sample string 9",
  "DeviceToken": "sample string 10",
  "DeviceVerNum": "sample string 11",
  "AllowEditTicket": true,
  "AllowRecordConditions": true
}

application/xml, text/xml

Sample: 
<DispatchDeviceUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Dispatch">
  <Alias>sample string 7</Alias>
  <AllowEditTicket>true</AllowEditTicket>
  <AllowRecordConditions>true</AllowRecordConditions>
  <ApplicatorDriverId>sample string 4</ApplicatorDriverId>
  <DeviceId>sample string 2</DeviceId>
  <DeviceToken>sample string 10</DeviceToken>
  <DeviceVerNum>sample string 11</DeviceVerNum>
  <DispatchDeviceGuid>1975f139-6f72-4e3c-8de0-d0c2b9db8a70</DispatchDeviceGuid>
  <DispatchType>sample string 3</DispatchType>
  <EMail>sample string 8</EMail>
  <OperatingSystemType>sample string 9</OperatingSystemType>
  <UserId>sample string 6</UserId>
  <VehicleId>sample string 5</VehicleId>
</DispatchDeviceUpdate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsDispatchDeviceUpdate'.

Response Information

Resource Description

Updates a DispatchDevice.

AgvDispatchDevice
NameDescriptionTypeAdditional Information
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": "d09c3bb5-695a-4f06-829a-a11b3b05c819",
      "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": "d09c3bb5-695a-4f06-829a-a11b3b05c819",
      "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>d09c3bb5-695a-4f06-829a-a11b3b05c819</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>d09c3bb5-695a-4f06-829a-a11b3b05c819</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>