...
Excerpt |
---|
Registers a mobile device of either type iOS or Android to an accountentity. Registration may optionally contain information about the device token for dispatch of push messages. This end point should be called once every time the mobile app is started. |
...
Endpoint ID: | 4001 | ||||
Method: |
|
...
| ||||||||||||||||||||||||||||||||||
URL: | /mobile/device/registration/entity/id/{entity-id} /mobile/device/registration/entity/ext-key/{ext-key}/{ext-type} | |||||||||||||||||||||||||||||||||
entity-id | Rubiq entity ID that uniquely identifies an account to register mobile device with | |||||||||||||||||||||||||||||||||
ext-key | External key that uniquely identifies an account to register mobile device with | |||||||||||||||||||||||||||||||||
ext-type | Type of external key | |||||||||||||||||||||||||||||||||
Request body: | JSON data with information about type of mobile device and optionally information about the device token for dispatch of push messages. Setting device ID will enable push messaging to the device.
| |||||||||||||||||||||||||||||||||
| JSON data with information about the newly registered mobile device
| |||||||||||||||||||||||||||||||||
Status codes: | 201 | Mobile device was registered successfully | ||||||||||||||||||||||||||||||||
303 | Mobile device is already registered for the calling app and the specified account This response will not have a response body, but will instead contain a Location header, referring to endpoint 4003: Get device which returns the relevant response body. | |||||||||||||||||||||||||||||||||
404 | Account was not found The following sub codes may be returned:
|