POST api/installation/deviceimeiswap
Swap an imei from the unallocated group and put it onto an existing service
Request Information
URI Parameters
None.
Body Parameters
The device imei swap model
DeviceIMEISwapModel| Name | 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. |
| UnAllocatedGroupID |
The group id where the unallocated units are saved |
unsigned integer |
None. |
| AllocatedGroupID |
The group id where the allocated units are saved |
unsigned integer |
None. |
| DisposedGroupID |
The group id where disassociated units are saved |
unsigned integer |
None. |
| VehicleList |
A list of vehicles to be disassociated |
Collection of IMEISwapVehicleModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"Token": "sample string 1",
"UserID": 2,
"UnAllocatedGroupID": 3,
"AllocatedGroupID": 4,
"DisposedGroupID": 5,
"VehicleList": [
{
"CurrentIMEI": "sample string 1",
"NewIMEI": "sample string 2",
"ServiceID": 3
},
{
"CurrentIMEI": "sample string 1",
"NewIMEI": "sample string 2",
"ServiceID": 3
}
]
}
application/xml, text/xml
Sample:
<DeviceIMEISwapModel 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>
<UnAllocatedGroupID>3</UnAllocatedGroupID>
<AllocatedGroupID>4</AllocatedGroupID>
<DisposedGroupID>5</DisposedGroupID>
<VehicleList>
<IMEISwapVehicleModel>
<CurrentIMEI>sample string 1</CurrentIMEI>
<NewIMEI>sample string 2</NewIMEI>
<ServiceID>3</ServiceID>
</IMEISwapVehicleModel>
<IMEISwapVehicleModel>
<CurrentIMEI>sample string 1</CurrentIMEI>
<NewIMEI>sample string 2</NewIMEI>
<ServiceID>3</ServiceID>
</IMEISwapVehicleModel>
</VehicleList>
</DeviceIMEISwapModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IMEISwapResponseModel
IMEISwapResponseModel| Name | 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:
<IMEISwapResponseModel 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> </IMEISwapResponseModel>