POST api/hirev2/deviceassociationv2
Creates a new service and associates an existing device to it
Request Information
URI Parameters
None.
Body Parameters
A DeviceAssociationModel object
DeviceAssociationV2ModelName | 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. |
equipmentList |
A list of equipment to be associated to devices |
Collection of DeviceAssociationV2EquipmentModel |
None. |
Request Formats
application/json, text/json
Sample:
{ "token": "sample string 1", "userID": 2, "equipmentList": [ { "ecode": "sample string 1", "commCode": "sample string 2", "imei": "sample string 3", "deviceEcode": "sample string 4", "description": "sample string 5", "categoryLow": "sample string 6", "categoryMid": "sample string 7", "categoryHigh": "sample string 8", "make": "sample string 9", "model": "sample string 10" }, { "ecode": "sample string 1", "commCode": "sample string 2", "imei": "sample string 3", "deviceEcode": "sample string 4", "description": "sample string 5", "categoryLow": "sample string 6", "categoryMid": "sample string 7", "categoryHigh": "sample string 8", "make": "sample string 9", "model": "sample string 10" } ] }
application/xml, text/xml
Sample:
<DeviceAssociationV2Model 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> <equipmentList> <DeviceAssociationV2EquipmentModel> <ecode>sample string 1</ecode> <commCode>sample string 2</commCode> <imei>sample string 3</imei> <deviceEcode>sample string 4</deviceEcode> <description>sample string 5</description> <categoryLow>sample string 6</categoryLow> <categoryMid>sample string 7</categoryMid> <categoryHigh>sample string 8</categoryHigh> <make>sample string 9</make> <model>sample string 10</model> </DeviceAssociationV2EquipmentModel> <DeviceAssociationV2EquipmentModel> <ecode>sample string 1</ecode> <commCode>sample string 2</commCode> <imei>sample string 3</imei> <deviceEcode>sample string 4</deviceEcode> <description>sample string 5</description> <categoryLow>sample string 6</categoryLow> <categoryMid>sample string 7</categoryMid> <categoryHigh>sample string 8</categoryHigh> <make>sample string 9</make> <model>sample string 10</model> </DeviceAssociationV2EquipmentModel> </equipmentList> </DeviceAssociationV2Model>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A HireResponseModel indicating if the device was associated successfully
HireResponseModelName | 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>