POST api/device/UpdateDevice?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}
This method allow you to modify detail information of registered device.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
ApplicationKey |
The application identity issued by an authorized publisher of Traxia services. This identity is unique and generated one-time during registration. |
string |
Required |
APIKey |
Secret key issued to be challenged as identity verification. |
string |
Required |
DeviceID |
Unique code to identify a device that connects to the Traxia system, such as IMEI. |
string |
None |
Body Parameters
In the Traxia 6, parameter body consists of parameters and values, the parameters used in this case are lookup and inquiry.
DeviceName | Description | Type | Additional Information |
---|---|---|---|
DeviceID |
Unique code to identify a device that connects to the Traxia system, such as IMEI. |
string |
Required |
DeviceModelID |
Unique code which identify a device model that connects to the Traxia system. |
integer |
Required |
ResellerID |
The ID of the seller of the device. |
integer |
None |
PurchaseDate |
The date the device was purchased. |
date |
None |
InstallDate |
The date when the device was installed. |
date |
None |
FirmwareVersion |
The current version of the device firmware. |
string |
None |
Description |
A brief description of the model device. |
string |
None |
Remarks |
Provides comment from user to give detail about the data. |
string |
None |
SubscriberID | integer |
None |
|
GUID | string |
None |
|
CreatedBy |
The person who responded to register the data (filled in only when registering). |
string |
None |
CreatedTimeStamp |
The time when a data record was created. |
date |
None |
LastUpdateBy |
The last person who modified the data (filled only when updating). |
string |
None |
LastUpdateTimeStamp |
The time when a data record was modified (filled only when updating). |
date |
None |
Discard |
Status of enabling or disabling data visibility to the system. (filled in only when disabling or enabling). |
boolean |
None |
DiscardBy |
The last person who discarded the data. (filled in only when disabling). |
string |
None |
DiscardTimeStamp |
Information about the time when the last discard data happened (filled in only when disabling). |
date |
None |
Request Formats
application/json, text/json
// parameter to update the device { "DeviceID": "Test123",//mandatory, your device id, string "DeviceModelID": 1,// mandatory, your device model id, string "SubscriberID": 1,// mandatory, your subscriber id, integer "UpdateBy": "care@dit.co.id",// mandatory, email from the responsible person, string "LastUpdateTimeStamp": "2021-05-03T03:31:02.807",// mandatory, yyyy-mm-dd hh:mm:ss }
application/xml, text/xml
<Device xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Traxia.Credential.Devices"> <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 8</CreatedBy> <CreatedTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</CreatedTimeStamp> <Discard xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">true</Discard> <DiscardBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 11</DiscardBy> <DiscardTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</DiscardTimeStamp> <GUID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 7</GUID> <LastUpdateBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 9</LastUpdateBy> <LastUpdateTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</LastUpdateTimeStamp> <SubscriberID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">6</SubscriberID> <Description>sample string 4</Description> <DeviceID>sample string 1</DeviceID> <DeviceModelID>2</DeviceModelID> <FirmwareVersion>sample string 3</FirmwareVersion> <InstallDate>2024-12-18T15:57:00.3474711+07:00</InstallDate> <PurchaseDate>2024-12-18T15:57:00.3474711+07:00</PurchaseDate> <Remarks>sample string 5</Remarks> <ResellerID>1</ResellerID> </Device>
multipart/form-data
<Device xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Traxia.Credential.Devices"><CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 8</CreatedBy><CreatedTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</CreatedTimeStamp><Discard xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">true</Discard><DiscardBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 11</DiscardBy><DiscardTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</DiscardTimeStamp><GUID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 7</GUID><LastUpdateBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 9</LastUpdateBy><LastUpdateTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T15:57:00.3474711+07:00</LastUpdateTimeStamp><SubscriberID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">6</SubscriberID><Description>sample string 4</Description><DeviceID>sample string 1</DeviceID><DeviceModelID>2</DeviceModelID><FirmwareVersion>sample string 3</FirmwareVersion><InstallDate>2024-12-18T15:57:00.3474711+07:00</InstallDate><PurchaseDate>2024-12-18T15:57:00.3474711+07:00</PurchaseDate><Remarks>sample string 5</Remarks><ResellerID>1</ResellerID></Device>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
BaseResponseName | Description | Type | Additional Information |
---|---|---|---|
Acknowledge |
Acknowledgement of API request format, whether you are submitting the requested parameter in a proper format. |
Acknowledge |
None |
ResponseCode |
Indicates the result of your API service process. Negative results may have different code indicators depending on their failure type. |
ResponseCode |
None |
ResponseMessage |
Negative API process results may have additional information in text to explain the failure reasons. |
string |
None |
Data |
Data provide a universal object response model transformed into JSON compatible format. You will need to recognize the type of returned object model of each of your request. For more information about object class model, please consult our object class library documentation. |
Object |
None |
Latency | integer |
None |
Response Formats
application/json, text/json
// Succesful result of update device { "Acknowledge": 1, "ResponseCode": 200, "ResponseMessage": "Request was succesfully performed.", "Data": "Test123" }