POST api/installation/devicedispose
Dispose services which are no longer needed
Request Information
URI Parameters
None.
Body Parameters
The device dispose model
DeviceDisposeModelName | Description | Type | Additional information |
---|---|---|---|
Token |
The token returned after login used for authentication |
string |
None. |
UserID |
The userid returned after login used for authentication |
unsigned integer |
None. |
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:
{ "Token": "sample string 1", "UserID": 2, "AllocatedGroupID": 3, "DisposedGroupID": 4, "VehicleList": [ { "IMEI": "sample string 1", "ServiceID": 2 }, { "IMEI": "sample string 1", "ServiceID": 2 } ] }
application/xml, text/xml
Sample:
<DeviceDisposeModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Token>sample string 1</Token> <UserID>2</UserID> <AllocatedGroupID>3</AllocatedGroupID> <DisposedGroupID>4</DisposedGroupID> <VehicleList> <DeviceDisposeVehicleModel> <IMEI>sample string 1</IMEI> <ServiceID>2</ServiceID> </DeviceDisposeVehicleModel> <DeviceDisposeVehicleModel> <IMEI>sample string 1</IMEI> <ServiceID>2</ServiceID> </DeviceDisposeVehicleModel> </VehicleList> </DeviceDisposeModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DisposeResponseModel
DisposeResponseModelName | Description | Type | Additional 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>