User device subscription

This API allows an external application to get the delivery device addresses of a user.

Get user device addresses

This API call obtains the devices and addresses to which the user is subscribed. To learn about the XML format, see SDK envelope request.

The payload type is

GET-USER-DEVICE-ADDRESS

. The payload content uses the following format:

<userDeviceAddresses>
<user>
<mid>mid</mid>
<userId>user-id</userId>
</user>
<deliveryPreferences>
<addressId>optional address id</addressId>
</deliveryPreferences>
</userDeviceAddresses>

Mandatory nodes

<user>: Either the <mid> or the <userId> sub-node must be populated. If both are populated, <userId> will take priority over <mid>.

<mid>: A mapping ID, to uniquely identify the user between the systems.

<userId>: An existing

BlackBerry AtHoc

user identity.

Optional nodes

<addressId> (optional): Gets details for the specified address only. If not supplied, returns details for all the device addresses for the user.

The SDK response will be:

<reponsePayload>
<device>
<deviceId>device id</deviceId>
<deviceCommonName>device common name</deviceCommonName>
<deviceName>device name</deviceName>
<isMandatory>Y|N</isMandatory>
<isEditable>Y|N</isEditable>
<deviceAddress>
<addressId>address id</addressId>
<address>user@company.com</address>
<addressLabel>display name for address</addressLabel>
<isPrimary>Y/N</isPrimary>
<isValidated> Y/N </isValidated>
</deviceAddress>
</device>
<device>
. . .
</device>
…
</responsePayload>

Section:

User synchronization