Registration

Registration is a generalized mechanism that is used by devices such as vehicles and back office systems to build and manage a profile in the BlackBerry Device Management system. The registration API is a critical step in the life cycle of an update. Devices must be registered with the system and the registration information must be kept current from all sources in order to facilitate relevant and efficient software updates.

Registration request

The registration request structure and an example are given below.

Registration request header

The table below provides the fields required in the header of a registration request.

Field	Required	Type	Description	Example Value(s)
protocol	yes	Object	Metadata about the protocol that is being used.	N/A
protocol.name	yes	String	A name key that identifies the protocol.	Registration
protocol.version	yes	String	The version of the protocol that is being used.	4.0.0
protocol.type	yes	String	The type of the protocol. Possible values are: REQUEST - Indicates this is a request to the server. RESPONSE - Indicates this is a response from the server to the client.	REQUEST
tenantId	yes	String	The identifier of the tenant that this endpoint belongs to.	example_tenant
deviceId	yes	String	The unique identifier for the device on the given tenant.	1XKADP9X7CJ328889
sourceId	yes	String	The originating source of the request.	ENDPOINT
sessionId	yes	String	A client-generated value that should uniquely identify a series of transactions that are related to each other.	1220320-231ffw

Registration request URL

POST https://ps.dcms.blackberry.com/dmps/registration/4.0.0

Registration request example

The following is an example of a Registration request.

Registration response

The registration response structure and an example are given below.

Registration response header

The following depicts the registration response header structure.

Field	Required	Type	Description	Example Value(s)
protocol	yes	Object	Metadata about the protocol that is being used.	N/A
protocol.name	yes	String	A name key that identifies the protocol.	Registration
protocol.version	yes	String	The version of the protocol that is being used.	4.0.0
protocol.type	yes	String	The type of the protocol. Possible values are: REQUEST - Indicates this is a request to the server. RESPONSE - Indicates this is a response from the server to the client.	RESPONSE
tenantId	yes	String	The identifier of the tenant that this endpoint belongs to.	example_tenant
deviceId	yes	String	The unique identifier for the device on the given tenant.	1XKADP9X7CJ328889
sessionId	yes	String	A client-generated value that should uniquely identify a series of transactions that are related to each other.	1220320-231ffw
status.code	yes	String	A server-generated code that indicates the result of sending the request to the server.	0
status.message	yes	String	A message that correlates to the status code and provides additional information about the code.	Success

Registration response example

The following is an example of a registration response.