POST api/PushNotificationRegister/RegisterDevice/{id}?authToken={authToken}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken | string |
Required |
|
id | string |
Required |
Body Parameters
DeviceRegistrationModelName | Description | Type | Additional information |
---|---|---|---|
Platform | string |
None. |
|
Handle | string |
None. |
|
Tags | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Platform": "sample string 1", "Handle": "sample string 2", "Tags": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<DeviceRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models"> <Handle>sample string 2</Handle> <Platform>sample string 1</Platform> <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Tags> </DeviceRegistrationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResultName | Description | Type | Additional information |
---|---|---|---|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml, text/xml
Sample:
<ServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results"> <ErrorCode>None</ErrorCode> <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ErrorMessage> <Success>true</Success> </ServiceResult>