Traxia 6 Help Documentation

Introduction

Traxia’s Credential API (Application Programming Interfaces) is a unique identifier system that must be followed when making a call to Traxia 6 system via an API. These docs will help you to set up your integration environment in building connections through Traxia 6 API. Use your API Key and Application Key to interact with Traxia 6 API.

Asset

This API provides you to manage and modify information of the asset that connects to the Traxia 6 system.

API	Description
POST api/asset/RegisterAsset?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to register new asset in Traxia Service.
POST api/asset/UpdateAsset?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to modify detail information of registered asset in Traxia service.
POST api/asset/RetrieveAssetInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to get detail information of asset in Traxia Service.
POST api/asset/RetrieveAssetList?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method will provide information of all registered asset in Traxia Service.
POST api/asset/DeleteAsset?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provide capability to discard or disable existing asset in Traxia.

AssetModel

This API provides you to manage and modify information of the asset model that connects to the Traxia 6 system.

API	Description
POST api/assetmodel/RetrieveAssetModel?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method will provide information of all registered asset model in Traxia Service.

Authentication

This API provide you to request authentication data from Traxia Authentication.

API	Description
GET api/authentication/AuthenticateUserAccess?EmailAddress={EmailAddress}&Token={Token}&APIUri={APIUri}&MethodUri={MethodUri}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows the Traxia system to authenticate user access, the authentication is needed for the Traxia system to identify and control which API or apps can be accessed by a user.
GET api/authentication/AuthenticateApplicationAccess?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows the Traxia system to authenticate application access, this authentication is needed for communication between application (such as console apps want to access apps).
GET api/authentication/AuthenticateApiAccess?APIUri={APIUri}&MethodUri={MethodUri}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows the Traxia system to authenticate API from one app or system and giving granular control over how the apps can access Traxia 6 system.
GET api/authentication/ReturnTokenStatus?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to grant access for user to application.

Device

This API provides you to manage and modify information of the device that connects to the Traxia 6 system.

API	Description
POST api/device/RegisterDevice?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to register a new device and connect to Traxia 6 system.
POST api/device/RetrieveDeviceInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get detailed information about the device that connects to the Traxia 6 system.
POST api/device/RetrieveDeviceList?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get a list of information of all registered devices.
POST api/device/UpdateDevice?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to modify detail information of registered device.
POST api/device/DisableDevice?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to discard or disable an existing device on Traxia 6 system.
POST api/device/EnableDevice?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to re-enable a device that has been discarded.

DeviceModel

This API provides you to manage and modify information of the device model that connects to the Traxia 6 system.

API	Description
POST api/devicemodel/RegisterDeviceModel?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to register a new device model for login in Traxia 6 system.
POST api/devicemodel/RetrieveDeviceModelInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get detailed information of device models that are already registered on the Traxia 6 system.
POST api/devicemodel/RetrieveDeviceModelList?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides model information of existing devices on the Traxia 6 system.
POST api/devicemodel/UpdateDeviceModel?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to modify the device model for the existing device on the Traxia 6 system.
POST api/devicemodel/DisableDeviceModel?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to discard or disable existing devices based on the model.
POST api/devicemodel/EnableDeviceModel?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to re-enable model device that has been discarded.

SIMCard

This API provide you to manage and modify information of SIM card in the Traxia simcard.

API	Description
POST api/simcard/RegisterSIMCard?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to register a new SIM card for login.
POST api/simcard/RetrieveSIMCardInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get detailed information about SIM cards.
POST api/simcard/RetrieveSIMCardList?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method will provide information on all registered SIM cards.
POST api/simcard/UpdateSIMCard?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to modify detailed information of registered SIM cards.
POST api/simcard/DisableSIMCard?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to discard or disable existing SIM cards.
POST api/simcard/EnableSIMCard?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to re-enable SIM cards that have been discarded.

Subscriber

This API provides you to manage and modify the information of subscribers in Traxia subscribers.

API	Description
POST api/subscriber/RegisterSubscriber?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to register a new subscriber for login.
POST api/subscriber/RetrieveSubscriberInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get detailed subscriber information.
POST api/subscriber/RetrieveSubscriberList?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method will provide information of all registered subscribers.
POST api/subscriber/UpdateSubscriber?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allow you to modify the detailed information of the registered subscriber.
POST api/subscriber/DisableSubscriber?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to discard or disable existing subscribers.
POST api/subscriber/EnableSubscriber?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to re-enable subscribers who have been discarded.
POST api/subscriber/SignUp?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method is an authentication system in Traxia that allows you to register users who have device id.
POST api/subscriber/ReturnActivationData?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method is an authentication system in Traxia that allows you to re-activation your account.
POST api/subscriber/Activate?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method is an authentication system in Traxia that allows you to activate your account.

User

This API provides you to manage and modify the information of the user in the Traxia 6 system.

API	Description
POST api/user/RegisterUser?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to register a new user for the login on Traxia 6 system.
POST api/user/RetrieveUserInfo?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get detailed information about the user.
POST api/user/RetrieveUserList?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to get a list of information from all registered users.
POST api/user/UpdateUser?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to modify the detailed information of a registered user.
POST api/user/DisableUser?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to discard or disable an existing user from the Traxia 6 system.
POST api/user/EnableUser?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method provides the capability to re-enable user that has been disabled or discard before.
POST api/user/AuthenticateUser?EmailAddress={EmailAddress}&Password={Password}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to authenticate user credentials based on username and password.
POST api/user/ReturnConnectedApplication?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to check what applications are currently connected to your account.
POST api/user/DeleteConnectedApplication?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	No documentation available.
POST api/user/RequestForgotPassword?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to request forgot password.
POST api/user/ValidateForgotPassword?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to validate your forgot password request.
POST api/user/ResetPassword?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to reset your password.
POST api/user/UpdateProfile?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	This method allows you to modify detailed information of registered users.
POST api/user/ReturnExistingUserApplication?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	No documentation available.
POST api/user/RegisterUserApplicationAccess?ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	No documentation available.
POST api/user/ReturnConnectedUserDevices?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	No documentation available.
POST api/user/DeleteConnectedUserDevices?EmailAddress={EmailAddress}&Token={Token}&ApplicationKey={ApplicationKey}&APIKey={APIKey}&DeviceID={DeviceID}	No documentation available.