Notification service

A REST API towards a Pointsharp ID notifications.

API Description

POST Notification/Destination

Creates and sends a notification message using the destination given by the request.

POST Notification/User

Creates and sends a notification message to the user given by the request.

POST Notification/Destination

Creates and sends a notification message using the destination given by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the notification to send.

Define this parameter in the request body.

Parameter information

request

Contains data specifying the notification to send.

Property Description Additional information

Destination (String)

The destination address, for example, mobile phone number or email address.

This parameter is required.

Message (String)

The message to send to the user.

This parameter is required.

Method (String)

The name of the notification method to use.

This parameter is required.

Request body formats

application/json, text/json 
{
  "Method": "sample string 1",
  "Message": "sample string 2",
  "Destination": "sample string 3"
}
application/xml, text/xml 
<NotificationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Method>sample string 1</Method>
  <Message>sample string 2</Message>
  <Destination>sample string 3</Destination>
</NotificationRequest>

Response information

The notification data.

Response body formats

application/json, text/json 
{
  "Destinations": {
    "$type": "System.Collections.Generic.List`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Message": "sample string 1"
}

POST Notification/User

Request information

Parameters

Name Description Additional information

request

The request data specifying the notification to send.

Define this parameter in the request body.

Parameter information

request

Contains data specifying the notification to send.

Property Description Additional information

Message (String)

The message to send to the user.

This parameter is required.

Method (String)

The name of the notification method to use.

This parameter is required.

UserAttribute (String)

The user’s attribute containing the destination address, e.g. 'mobile' or 'mail'.

This parameter is required.

Username (String)

The name of the user.

This parameter is required.

UserStorageName (String)

The name of the storage where the user resides. If this value is NULL (not set) then Pointsharp ID tries to find the unique user by searching through all configured user storages.

This parameter is optional.

Request body formats

application/json, text/json 
{
  "Method": "sample string 1",
  "Message": "sample string 2",
  "UserAttribute": "sample string 3",
  "Username": "sample string 4",
  "UserStorageName": "sample string 5"
}
application/xml, text/xml 
<UserNotificationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 4</Username>
  <UserStorageName>sample string 5</UserStorageName>
  <Method>sample string 1</Method>
  <Message>sample string 2</Message>
  <UserAttribute>sample string 3</UserAttribute>
</UserNotificationRequest>

Response information

The notification data.

Response body formats

application/json, text/json 
{
  "Destinations": {
    "$type": "System.Collections.Generic.List`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Message": "sample string 1"
}