POST apioauth/hirev2/deviceremovalv2
Remove a device from a service so the device can be used again
Request Information
URI Parameters
None.
Body Parameters
A DeviceRemovalModel object
OAuthDeviceRemovalV2Model| Name | Description | Type | Additional information |
|---|---|---|---|
| equipmentList |
A list of equipment to be removed from devices |
Collection of DeviceRemovalV2EquipmentModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"equipmentList": [
{
"ecode": "sample string 1",
"commCode": "sample string 2",
"imei": "sample string 3",
"deviceEcode": "sample string 4"
},
{
"ecode": "sample string 1",
"commCode": "sample string 2",
"imei": "sample string 3",
"deviceEcode": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<OAuthDeviceRemovalV2Model xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<equipmentList>
<DeviceRemovalV2EquipmentModel>
<ecode>sample string 1</ecode>
<commCode>sample string 2</commCode>
<imei>sample string 3</imei>
<deviceEcode>sample string 4</deviceEcode>
</DeviceRemovalV2EquipmentModel>
<DeviceRemovalV2EquipmentModel>
<ecode>sample string 1</ecode>
<commCode>sample string 2</commCode>
<imei>sample string 3</imei>
<deviceEcode>sample string 4</deviceEcode>
</DeviceRemovalV2EquipmentModel>
</equipmentList>
</OAuthDeviceRemovalV2Model>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A HireResponseModel indicating if the device was associated successfully
HireResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| request_status |
Status indicating if a web service call was successful |
boolean |
None. |
| request_message |
Any extra information indicating why a call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"request_status": true,
"request_message": "sample string 2"
}
application/xml, text/xml
Sample:
<HireResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <request_status>true</request_status> <request_message>sample string 2</request_message> </HireResponseModel>