POST apioauth/installation/devicedispose

Dispose services which are no longer needed

Request Information

URI Parameters

None.

Body Parameters

The device dispose model

OAuthDeviceDisposeModel
NameDescriptionTypeAdditional information
AllocatedGroupID

The group id where the allocated units are saved

 unsigned integer

None.
DisposedGroupID

The group id where disposed units are saved

 unsigned integer

None.
VehicleList

A list of vehicles to be disposed

 Collection of DeviceDisposeVehicleModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "AllocatedGroupID": 1,
  "DisposedGroupID": 2,
  "VehicleList": [
    {
      "IMEI": "sample string 1",
      "ServiceID": 2
    },
    {
      "IMEI": "sample string 1",
      "ServiceID": 2
    }
  ]
}

application/xml, text/xml

Sample: 
<OAuthDeviceDisposeModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AllocatedGroupID>1</AllocatedGroupID>
  <DisposedGroupID>2</DisposedGroupID>
  <VehicleList>
    <DeviceDisposeVehicleModel>
      <IMEI>sample string 1</IMEI>
      <ServiceID>2</ServiceID>
    </DeviceDisposeVehicleModel>
    <DeviceDisposeVehicleModel>
      <IMEI>sample string 1</IMEI>
      <ServiceID>2</ServiceID>
    </DeviceDisposeVehicleModel>
  </VehicleList>
</OAuthDeviceDisposeModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DisposeResponseModel

DisposeResponseModel
NameDescriptionTypeAdditional information
RequestStatus

Status indicating if a web service call was successful

 boolean

None.
RequestMessage

Any extra information indicating why a call was not successful

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "RequestStatus": true,
  "RequestMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<DisposeResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RequestStatus>true</RequestStatus>
  <RequestMessage>sample string 2</RequestMessage>
</DisposeResponseModel>