Skip to content

registerUserDevice ​

Registers a User's device against their User record. User must be authenticated first

Request ​

http
POST /rest/user/register/device

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

json
{
"deviceId":"WSTESTS#SomeSuperFunkyDeviceId",
"pushToken":"SomePushTokenReceivedFromApple",
"deviceName":"Peter's iPad",
"deviceType":"iPad", "iPhone", "Android Tablet", or "Android Phone"
"appCode": "NI" or "MY"
}
json
{"deviceId":"WSTESTS#SomeSuperFunkyDeviceId","pushToken":null,"deviceName":null}
json
{"deviceId":"WSTESTS#SomeSuperFunkyDeviceId","pushToken":"SomePushTokenReceivedFromApple"}
json
{"deviceId":"WSTESTS#SomeSuperFunkyDeviceId","pushToken":"SomePushTokenReceivedFromApple","deviceName":"Peter's iPad"}
json
{"deviceId":"WSTESTS#SomeSuperFunkyANDROIDDeviceId","pushToken":"SomeAndroidPUSHTokenGoesHerePlease","deviceName":"NI WSTESTS# Aaron's Android Tablet","deviceType":"Android Tablet","appCode":"MY"}

Response ​

200 OK ​

json
{"errorCode":0,"errorMsg":"DeviceId registered."}

Where 0 means success, anything else is an error.

Errors ​

ExceptionDescription
WSUserServiceUnavailableExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSUserServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions