With this API call the user (client) registers its device or software service to the ETX system. Therefore, when a connection is initiated from the device or software service to the ETX system along with the credential provided by this registration call, then the connection will be authorized.
Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.
thingspace_oauth sessionToken Access/Bearer token needed to authorize the user. The Bearer/Access Token should be acquired by using the ThingSpace Portal (thingspace.verizon.com). For details on how to obtain the token please refer to the
In: header
This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the
In: header
Optional transaction identifier for tracing requests. If not provided, the application will generate one.
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$uuid36 <= length <= 36application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request for v2/clients/registration endpoint. It requires the Client Type, Subtype and Vendor to be defined.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/clients/registration" \ -H "Content-Type: application/json" \ -d '{ "ClientType": "Vehicle", "ClientSubtype": "PassengerCar", "VendorID": "VerizonETX" }'{ "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "Certificate": { "cert.pem": "\"-----BEGIN CERTIFICATE-----\nMIIDrjCCApagAwIBAgICEAEwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UEBhMCQVUx\n...\nuuA1Zog3aBOeeEzp9SEJBMTJRYPXbK4e8Xer+7m98OL/3g==\n-----END CERTIFICATE-----\"\n", "key.pem": "\"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END PRIVATE KEY-----\"\n", "ca.pem": "\"-----BEGIN CERTIFICATE-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END CERTIFICATE-----\"\n", "ExpirationTime": "2017-07-21T17:32:28Z" }}{ "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "Message": "Client registration is in pending state due to the unfinished certificate generation. Please call the PUT API to finish the registration."}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}The type of the client that is to be registered. This is one of the major traffic participant groups considered in V2X communication. The system uses this value to define which topics the client will be able to publish and subscribe to.
Values:
Value in
The subtype or subgroup of the client type. This further specifies the client type. For example it will specify if the client is a passenger car or a truck. See the ClientType description for the supported Subtypes for each client type.
Value in
The ID the vendor wants its devices to be registered under. E.g. Verizon, GM, Ford, etc.
^[a-zA-Z0-9]+$length <= 64The generated ID (UUID v4) for the device. It can be used as:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$uuid36 <= length <= 36The IMEI number of the device.
^(\d{2}-\d{6}-\d{6}-\d{1,2})$|^(\d{15,16})$length <= 19The ICCID number of the device.
^(89\d{17,18})$19 <= length <= 20The IMSI number of the device.
^\d{14,15}$14 <= length <= 15