POST api/installation/deviceassociation
Associate a service to a device into the unalloacted group.
Request Information
URI Parameters
None.
Body Parameters
DeviceAssociationModel
DeviceAssociationModelName | Description | Type | Additional information |
---|---|---|---|
Token |
The token returned after login used for authentication |
string |
None. |
UserID |
The user id 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. |
VehicleList |
A list of vehicles to be associated to devices |
Collection of DeviceAssociationVehicleModel |
None. |
Request Formats
application/json, text/json
Sample:
{ "Token": "sample string 1", "UserID": 2, "UnAllocatedGroupID": 3, "AllocatedGroupID": 4, "VehicleList": [ { "IMEI": "sample string 1", "VehicleRegistration": "sample string 2", "ServiceType": 0, "ServiceRegion": 0 }, { "IMEI": "sample string 1", "VehicleRegistration": "sample string 2", "ServiceType": 0, "ServiceRegion": 0 } ] }
application/xml, text/xml
Sample:
<DeviceAssociationModel 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> <VehicleList> <DeviceAssociationVehicleModel> <IMEI>sample string 1</IMEI> <VehicleRegistration>sample string 2</VehicleRegistration> <ServiceType>v0Default</ServiceType> <ServiceRegion>Europe</ServiceRegion> </DeviceAssociationVehicleModel> <DeviceAssociationVehicleModel> <IMEI>sample string 1</IMEI> <VehicleRegistration>sample string 2</VehicleRegistration> <ServiceType>v0Default</ServiceType> <ServiceRegion>Europe</ServiceRegion> </DeviceAssociationVehicleModel> </VehicleList> </DeviceAssociationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AssociationResponseModel
AssociationResponseModelName | 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. |
IMEILookup |
A list of imeis to service id |
Collection of IMEIServiceIDLookup |
None. |
Response Formats
application/json, text/json
Sample:
{ "RequestStatus": true, "RequestMessage": "sample string 2", "IMEILookup": [ { "IMEI": "sample string 1", "ServiceID": 2 }, { "IMEI": "sample string 1", "ServiceID": 2 } ] }
application/xml, text/xml
Sample:
<AssociationResponseModel 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> <IMEILookup> <IMEIServiceIDLookup> <IMEI>sample string 1</IMEI> <ServiceID>2</ServiceID> </IMEIServiceIDLookup> <IMEIServiceIDLookup> <IMEI>sample string 1</IMEI> <ServiceID>2</ServiceID> </IMEIServiceIDLookup> </IMEILookup> </AssociationResponseModel>