POST api/user/UpdateUser?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}
This method allows you to modify the detailed information of a registered user.
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
Submit the user object information to be updated.
UserName | Description | Type | Additional Information |
---|---|---|---|
UserID |
Unique code that works as an identifier for users who registered on the Traxia system (just filled when update). |
integer |
None |
EmailAddress |
Primary Key, use the email address for Register, Update, Enable, Disable and Retrieve. |
string |
None |
UserName |
The username that will be used in the Traxia system. |
string |
None |
FullName |
The full name of the user that will be used in the Traxia system. |
string |
None |
Address |
The user address which will be info and stored on the Traxia service. |
string |
None |
PhoneNumber |
The user's mobile number which will become info and stored in the Traxia system. |
string |
None |
Password |
Password that will be the secret key to log in. |
string |
None |
Avatar |
The image link that will be used for the user's profile. |
string |
None |
CountryName |
The subscriber country of origin which will be info and stored in the Traxia system. |
string |
None |
GMT |
GMT from the marketing area which will be used by the Traxia system to determine the timestamp for the formation of fleet management operation. |
integer |
None |
LastLogin |
information about the time when the user last login. |
date |
None |
MobileRole |
User role on Traxia mobile apps platform. |
string |
None |
WebRole |
User role on Traxia web platform. |
string |
None |
OTP |
To make sure the security of the user, Traxia used 2 step verification, it can be sent unique code by email and SMS to the user. |
string |
None |
OTPExpiry |
The OTP has a limitation life depend on the time, so when the user register but does not verify, so OTP will be expired and cannot be used again. |
date |
None |
IsActivated |
Check whether the user is active or not on Traxia system. |
boolean |
None |
ActivationTimeStamp |
Information about time when user active on the Traxia system. |
date |
None |
Lon |
Geographic coordinate that specifies the east–west position of an asset on the Earth's surface. |
decimal number |
None |
Lat |
Geographic coordinate that specifies the north–south position of an asset on the Earth's surface. |
decimal number |
None |
ResetToken |
To reset your token which will be used as user credentials in the Traxia system. |
string |
None |
ExpiryTimeStamp |
Time information regarding the expiration of the account activation period. |
date |
None |
Culture |
User interface language. |
string |
None |
ColorSetting |
Indicates User's application color or theme personal settings. |
integer |
None |
UnitOfMeasurement |
Indicates user data Unit of Measurement wheter using Metric or Imperial. |
integer |
None |
IdentificationCode |
Provides User's personal ID, Citizenship ID or Pasport ID. |
string |
None |
DateOfBirth | date |
None |
|
Gender | string |
None |
|
Occupation | 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 user { "SubscriberID": 10,// mandatory, your subscriber id, integer "EmailAddress": "care.asyst@dit.co.id", //mandatory, your email, string "UserName": "traxia", // mandatory, your user name, string "Password":"traxia",// mandatory, your password, string "LastUpdateBy": "care@dit.co.id", // mandatory, the responsible email, string }
application/xml, text/xml
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Traxia.Credential.Users"> <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 26</CreatedBy> <CreatedTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+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 29</DiscardBy> <DiscardTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+07:00</DiscardTimeStamp> <GUID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 25</GUID> <LastUpdateBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 27</LastUpdateBy> <LastUpdateTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+07:00</LastUpdateTimeStamp> <SubscriberID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">24</SubscriberID> <ActivationTimeStamp>2024-12-18T16:03:27.1813594+07:00</ActivationTimeStamp> <Address>sample string 5</Address> <Avatar>sample string 8</Avatar> <ColorSetting>19</ColorSetting> <CountryName>sample string 9</CountryName> <Culture>sample string 18</Culture> <DateOfBirth>2024-12-18T16:03:27.1813594+07:00</DateOfBirth> <EmailAddress>sample string 2</EmailAddress> <ExpiryTimeStamp>2024-12-18T16:03:27.1813594+07:00</ExpiryTimeStamp> <FullName>sample string 4</FullName> <GMT>10</GMT> <Gender>sample string 22</Gender> <IdentificationCode>sample string 21</IdentificationCode> <IsActivated>true</IsActivated> <LastLogin>2024-12-18T16:03:27.1813594+07:00</LastLogin> <Lat>16.1</Lat> <Lon>15.1</Lon> <MobileRole>sample string 11</MobileRole> <OTP>sample string 13</OTP> <OTPExpiry>2024-12-18T16:03:27.1813594+07:00</OTPExpiry> <Occupation>sample string 23</Occupation> <Password>sample string 7</Password> <PhoneNumber>sample string 6</PhoneNumber> <ResetToken>sample string 17</ResetToken> <UnitOfMeasurement>20</UnitOfMeasurement> <UserID>1</UserID> <UserName>sample string 3</UserName> <WebRole>sample string 12</WebRole> </User>
multipart/form-data
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Traxia.Credential.Users"><CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 26</CreatedBy><CreatedTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+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 29</DiscardBy><DiscardTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+07:00</DiscardTimeStamp><GUID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 25</GUID><LastUpdateBy xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">sample string 27</LastUpdateBy><LastUpdateTimeStamp xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">2024-12-18T16:03:27.1813594+07:00</LastUpdateTimeStamp><SubscriberID xmlns="http://schemas.datacontract.org/2004/07/Traxia.Common">24</SubscriberID><ActivationTimeStamp>2024-12-18T16:03:27.1813594+07:00</ActivationTimeStamp><Address>sample string 5</Address><Avatar>sample string 8</Avatar><ColorSetting>19</ColorSetting><CountryName>sample string 9</CountryName><Culture>sample string 18</Culture><DateOfBirth>2024-12-18T16:03:27.1813594+07:00</DateOfBirth><EmailAddress>sample string 2</EmailAddress><ExpiryTimeStamp>2024-12-18T16:03:27.1813594+07:00</ExpiryTimeStamp><FullName>sample string 4</FullName><GMT>10</GMT><Gender>sample string 22</Gender><IdentificationCode>sample string 21</IdentificationCode><IsActivated>true</IsActivated><LastLogin>2024-12-18T16:03:27.1813594+07:00</LastLogin><Lat>16.1</Lat><Lon>15.1</Lon><MobileRole>sample string 11</MobileRole><OTP>sample string 13</OTP><OTPExpiry>2024-12-18T16:03:27.1813594+07:00</OTPExpiry><Occupation>sample string 23</Occupation><Password>sample string 7</Password><PhoneNumber>sample string 6</PhoneNumber><ResetToken>sample string 17</ResetToken><UnitOfMeasurement>20</UnitOfMeasurement><UserID>1</UserID><UserName>sample string 3</UserName><WebRole>sample string 12</WebRole></User>
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 user { "Acknowledge": 1, "ResponseCode": 200, "ResponseMessage": "Request was succesfully performed.", "Data": null }