16. Push Notifications
Content of this chapter
This chapter contains web service methods concerning push notifications.
16.1. SetPushNotificationPlanDate
Namespace: http://agnitas.org/ws/schemas
Sets the plan date of a push notification. This date is informative and has no effect in the delivery process of the notification.
16.1.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| id | {http://www.w3.org/2001/XMLSchema}int | ID of push notification |
| date | {http://www.w3.org/2001/XMLSchema}string | Plan date |
Format for plan date see "Date format".
16.1.2. Response elements
This webservice has no response elements.
16.1.3. SOAP Faults
The server returns a SOAP Fault, if the ID of the push notification is unknown or given date is invalid.
16.2. SendPushNotification
Namespace: http://agnitas.org/ws/schemas
Schedules a push notification for delivery.
16.2.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| id | {http://www.w3.org/2001/XMLSchema}int | ID of push notification |
| send_date | {http://www.w3.org/2001/XMLSchema}string | Date of delivery |
| expire_date | {http://www.w3.org/2001/XMLSchema}string | Expire date of notification |
Send date and expire date have following properties:
Format is IS8601 format „yyyy-mm-ddThh:MM:ssZ“
- yyyy is year, 4 digits
- mm is month, 2 digits
- dd is day, 2 digits
- hh is hour, 2 digits, 24h format
- MM is minute, 2 digits
- ss is second, 2 digits
- Timezone is UTC
- Both dates must be in future
- Expire date must be past send date (max. 4 weeks)
Example: 2017-03-08T:13:44:15Z
16.2.2. Response elements
This webservice has no response elements.
16.2.3. SOAP Faults
The server returns a Soap Fault, if the ID of the push notification is unknown, the state of the push notification is invalid (notification is already sent, …) or send date or expire date is invalid.