WNS Credentials (PUT)
Sets Windows Push Notification Services (WNS) credentials of the application with the application ID, environment, and version.
Roles
Users in the following roles are authorized to perform this operation:
- worklightadmin
- worklightdeployer
- worklightmonitor
- worklightoperator
Method
PUT
Path
/management-apis/1.0/runtimes/runtime-name/notifications/applications/application-name/wnsConf/application-env/application-version/
Example
https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/notifications/applications/myapplication/wnsConf/android/1.0/?locale=de_DE
Path Parameters
- runtime-name
- The name of the runtime. This is the context root of the runtime web application, without the leading slash.
- application-name
- The name of the application.
- application-env
- The application environment.
- application-version
- The application version number.
Query Parameters
Query parameters are optional.
- locale
- The locale used for error messages.
Consumes
application/json
Produces
application/json, application/xml, text/xml
Payload
The payload in JSON format has values for packageSID and clientSecret.
JSON Example
{
"clientSecret" : "82e4569er",
"packageSID" : "ms-app://s-123-566-78910",
}
Payload Properties
The payload has the following properties:- clientSecret
- The client secret received from WNS.
- packageSID
- The unique identifier of the app received from WNS.
Response
The status of set WNS credentials.
JSON Example
{
"productVersion" : {
"productVersion" : "7.1.0",
},
"project" : {
"name" : "PushNotifications",
},
"status" : "Success",
"type" : "SET_WNS_CREDENTIALS",
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<setWNSCredentialsStatus
status="Success"
type="SET_WNS_CREDENTIALS">
<productVersion productVersion="7.1.0"/>
<project name="PushNotifications"/>
</setWNSCredentialsStatus>
Response Properties
The response has the following properties:
- productVersion
- The exact product version.
- project
- Project name.
- status
- The WNS credentials are saved successfully.
- type
- Transaction type.
The productVersion has the following properties:
- productVersion
- The exact product version
The project has the following properties:
- name
- Name of the project
Errors
403The user is not authorized to call this service.
404 The corresponding runtime is not found or not running.
500 An internal error occurred.