POST apioauth/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

OAuthDeviceIMEISwapModel
NameDescriptionTypeAdditional information
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:
{
  "UnAllocatedGroupID": 1,
  "AllocatedGroupID": 2,
  "DisposedGroupID": 3,
  "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:
<OAuthDeviceIMEISwapModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UnAllocatedGroupID>1</UnAllocatedGroupID>
  <AllocatedGroupID>2</AllocatedGroupID>
  <DisposedGroupID>3</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>
</OAuthDeviceIMEISwapModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IMEISwapResponseModel

IMEISwapResponseModel
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:
<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>