Notifications v0.1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Notifications API manages the creation, organization, publishing and delivery of events or messages. This allows the Apiture system to inform loosely coupled recipients about events, changes, and actions.

Terminology

• Message - data which describes an action or event.
• Topic - topics are a way of grouping and organizing notifications by subject. Each topic can have many subscriptions, and when a message is published to a topic, each of the topic's active subscriptions will receive the notification.
• Notification - an instance of a message that is published to a topic and which has been matched with a subscription on that topic.
• Subscription - subscriptions are an outlet for consuming notifications and represent notification delivery channels such as email, SMS, pull subscriptions, or push subscriptions. In pull subscriptions, clients poll to receive queued notifications. For push subscriptions, the service sends notifications to a pre-configured endpoint via an HTTP POST request.

Behavior

When an event occurs, a service will POST a new message to a topic. The Notification service matches all active subscriptions on that topic and creates a notification for each subscription. The service stores pull notifications to be pulled later, or queues push notifications to a delivery queue.

By default, push notifications will persist in the /deliveryQueue for four days. During that time, the notifications service will attempt to call the external endpoint to deliver the message. Upon success, the notification is removed from the queue and moved to the /receivedNotifications collection. Received notifications can be retrieved at a later date for historical or audit logging purposes. If delivery fails after 4 days, the notification is moved to the /failedNotifications collection, which represents "dead letter queue".

Pull notifications skip the queueing process and are stored by the service. They can be fetched via a filtered GET query to /pullNotifications (operation getPullNotifications) or by GET to /topics/{topicId}/notifications (operation getNotificationsForTopic) or /subscriptions/{subscriptionId}/notifications (operation getNotificationsSubscription). After the client has processed the pull notification, it must acknowledge the notification by performing a POST operation to the href in the notification's _links.acknowledge link; this removes the notification from the active notifications collections. Pulled notifications that have not been acknowledged remain in the /pullNotifications collection and are considered by the service to be unacknowledged, which may result in duplicate processing of the notification.

The service publishes notifications to pre-existing topics, each of which may have any number of associated subscriptions. When a message is published to a topic, it notifies all active subscriptions and passes the notification body to them.

For example, a topic "LoanPaymentApplied" could be triggered any time a payment to a loan account has been applied. The topic is triggered by a POST to /notifications, where the request body has a _link to the topic. The topic could have two subscribers. The first subscription is a push subscription, which makes a callout to an authenticated endpoint. The server is configured to receive the request and send an SMS text message to the end user; the SMS number is in the subscription. A push subscription will be considered received by the endpoint server when a 200-level status code is received (including retries after 3xx status codes). The second subscription is a pull subscription. When pull subscriptions are triggered, the notification is added to a collection, where it waits until the client retrieves it.

Download OpenAPI Definition (YAML)

Base URLs:

• /notifications

Email: Apiture Web: Apiture

API

Endpoints which describe this API.

getApiDoc

Code samples

# You can also use wget
curl -X GET /notifications/apiDoc \
  -H 'Accept: application/json'

GET /notifications/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: '/notifications/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('/notifications/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/notifications/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/notifications/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

Response Schema

getApi

Code samples

# You can also use wget
curl -X GET /notifications/ \
  -H 'Accept: application/hal+json'

GET /notifications/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

Published Messages

Messages published to topics

publishMessage

Code samples

# You can also use wget
curl -X POST /notifications/messages \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /notifications/messages HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/messages',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "body": {
    "any": "valid",
    "json": "object"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/notifications/messages',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/notifications/messages',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/notifications/messages', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/notifications/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Publish a notification message on a topic

POST /messages

Publish a message on a topic, creating zero or more notifications that are delivered according to each subscription on the topic. The message topic is specified with the link apiture:topic in the message request body. Subscription delivery passes the message body to each of its subscriptions. By default, a message body can contain up to 256 kb of text data, including JSON and unformatted text.

A response with status code 202 from this endpoint confirms that the service has successfully queued notifications for delivery.

A response with status code 413 indicates that the payload body exceeds the 256 kb size limit.

If the eventual delivery of the notification fails (for example, if the destination endpoint of a push subscription is unauthorized), errors will be recorded in the notification's _error object. A message may include an apiture:entity link containing the URI of any related entity. This denotes the primary resource that the message pertains to and is used for filtering notification to only recipients which are entitled to access the entity. If the topic referenced by the apiture:topic link does not exist, the request to create the notification will fail.

Body parameter

{
  "body": {
    "any": "valid",
    "json": "object"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

400 Response

{
  "_profile": "http://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.637Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Notification

Endpoints which facilitate the delivery of notifications.

getPullNotifications

Code samples

# You can also use wget
curl -X GET /notifications/pullNotifications \
  -H 'Accept: application/hal+json'

GET /notifications/pullNotifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/pullNotifications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/pullNotifications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/pullNotifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/pullNotifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/pullNotifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/pullNotifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a collection of pull notification resources

GET /pullNotifications

Return a paginated sortable filterable searchable collection of notifications. These are pull notifications which have been created based on a topic and a pull subscrioption and are available for delivery polling. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

getPullNotification

Code samples

# You can also use wget
curl -X GET /notifications/pullNotifications/{notificationId} \
  -H 'Accept: application/hal+json'

GET /notifications/pullNotifications/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/pullNotifications/{notificationId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/pullNotifications/{notificationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/pullNotifications/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/pullNotifications/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/pullNotifications/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/pullNotifications/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this pull notification

GET /pullNotifications/{notificationId}

Return a HAL representation of this notification resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscription": {
      "href": "https://api.apiture.com/notifications/subscriptions/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/users/user/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:acknowledge": {
      "href": "https://api.apiture.com/notifications/receivedNotifications?notification=https://api.apiture.com/notifications/pullNotifications/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    }
  }
}

Responses

deleteNotification

Code samples

# You can also use wget
curl -X DELETE /notifications/pullNotifications/{notificationId} \
  -H 'Accept: application/hal+json'

DELETE /notifications/pullNotifications/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/pullNotifications/{notificationId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/pullNotifications/{notificationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/notifications/pullNotifications/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/notifications/pullNotifications/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/pullNotifications/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/notifications/pullNotifications/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this notification resource

DELETE /pullNotifications/{notificationId}

Delete this notification resource. Note that deleting a notification does not cancel in-flight delivery to subscribers.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

400 Response

{
  "_profile": "http://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.637Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getDeliveryQueue

Code samples

# You can also use wget
curl -X GET /notifications/deliveryQueue \
  -H 'Accept: application/hal+json'

GET /notifications/deliveryQueue HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/deliveryQueue',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/deliveryQueue',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/deliveryQueue',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/deliveryQueue', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/deliveryQueue");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/deliveryQueue", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a collection of push notifications that are queued for delivery

GET /deliveryQueue

Return a paginated sortable filterable searchable collection of notifications. These are notifications which have been created and are available for delivery. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

getPushNotification

Code samples

# You can also use wget
curl -X GET /notifications/deliveryQueue/{notificationId} \
  -H 'Accept: application/hal+json'

GET /notifications/deliveryQueue/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/deliveryQueue/{notificationId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/deliveryQueue/{notificationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/deliveryQueue/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/deliveryQueue/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/deliveryQueue/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/deliveryQueue/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of a queued push notification

GET /deliveryQueue/{notificationId}

Return a HAL representation of this notification resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscription": {
      "href": "https://api.apiture.com/notifications/subscriptions/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/users/user/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:acknowledge": {
      "href": "https://api.apiture.com/notifications/receivedNotifications?notification=https://api.apiture.com/notifications/pullNotifications/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    }
  }
}

Responses

deletePushNotification

Code samples

# You can also use wget
curl -X DELETE /notifications/deliveryQueue/{notificationId} \
  -H 'Accept: application/hal+json'

DELETE /notifications/deliveryQueue/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/deliveryQueue/{notificationId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/deliveryQueue/{notificationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/notifications/deliveryQueue/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/notifications/deliveryQueue/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/deliveryQueue/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/notifications/deliveryQueue/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this notification resource

DELETE /deliveryQueue/{notificationId}

Delete this notification resource. Note that deleting a notification does not cancel delivery to subscribers. Notifications are typically already queued by the time they are available for deletion from storage.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

400 Response

{
  "_profile": "http://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.637Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getFailedNotifications

Code samples

# You can also use wget
curl -X GET /notifications/failedNotifications \
  -H 'Accept: application/hal+json'

GET /notifications/failedNotifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/failedNotifications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/failedNotifications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/failedNotifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/failedNotifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/failedNotifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/failedNotifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a collection of failed notifications

GET /failedNotifications

Return a paginated sortable filterable searchable collection of notifications. These are notifications which have been created and are available for delivery and polling. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

getFailedNotification

Code samples

# You can also use wget
curl -X GET /notifications/failedNotifications/{notificationId} \
  -H 'Accept: application/hal+json'

GET /notifications/failedNotifications/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/failedNotifications/{notificationId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/failedNotifications/{notificationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/failedNotifications/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/failedNotifications/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/failedNotifications/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/failedNotifications/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this failed notification

GET /failedNotifications/{notificationId}

Return a paginated sortable filterable searchable collection of notifications. These are notifications which have been created and are available for delivery and polling. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscription": {
      "href": "https://api.apiture.com/notifications/subscriptions/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/users/user/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:acknowledge": {
      "href": "https://api.apiture.com/notifications/receivedNotifications?notification=https://api.apiture.com/notifications/pullNotifications/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    }
  }
}

Responses

getReceivedNotifications

Code samples

# You can also use wget
curl -X GET /notifications/receivedNotifications \
  -H 'Accept: application/hal+json'

GET /notifications/receivedNotifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/receivedNotifications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/receivedNotifications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/receivedNotifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/receivedNotifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/receivedNotifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/receivedNotifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a collection of notifications which have been received

GET /receivedNotifications

Return a paginated sortable filterable searchable collection of notifications. These are notifications which have been delivered through either push or pull. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

acknowledgeNotification

Code samples

# You can also use wget
curl -X POST /notifications/receivedNotifications \
  -H 'Accept: application/hal+json'

POST /notifications/receivedNotifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/receivedNotifications',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/receivedNotifications',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/notifications/receivedNotifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.post('/notifications/receivedNotifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/receivedNotifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/notifications/receivedNotifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Acknowledges a notification as received

POST /receivedNotifications

This operation Primarily for pull notifications. This changes the state of a notification to received, and removes the notification from the active collections and moves it to the /receivedNotifications collection.

This operation is invoked via a POST to the href in a pull notifcation's apiture:acknowledge link.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscription": {
      "href": "https://api.apiture.com/notifications/subscriptions/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/users/user/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:acknowledge": {
      "href": "https://api.apiture.com/notifications/receivedNotifications?notification=https://api.apiture.com/notifications/pullNotifications/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    }
  }
}

Responses

getReceivedNotification

Code samples

# You can also use wget
curl -X GET /notifications/receivedNotifications/{notificationId} \
  -H 'Accept: application/hal+json'

GET /notifications/receivedNotifications/{notificationId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/receivedNotifications/{notificationId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/receivedNotifications/{notificationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/receivedNotifications/{notificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/receivedNotifications/{notificationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/receivedNotifications/{notificationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/receivedNotifications/{notificationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this received notification

GET /receivedNotifications/{notificationId}

Return a paginated sortable filterable searchable collection of notifications. These are notifications which have been created and are available for delivery and polling. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscription": {
      "href": "https://api.apiture.com/notifications/subscriptions/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:entity": {
      "href": "https://api.apiture.com/users/user/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    },
    "apiture:acknowledge": {
      "href": "https://api.apiture.com/notifications/receivedNotifications?notification=https://api.apiture.com/notifications/pullNotifications/ff968d9f-8bf7-412e-ba31-7d9047cb96b3"
    }
  }
}

Responses

getNotificationsSubscription

Code samples

# You can also use wget
curl -X GET /notifications/subscriptions/{subscriptionId}/notifications \
  -H 'Accept: application/hal+json'

GET /notifications/subscriptions/{subscriptionId}/notifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/subscriptions/{subscriptionId}/notifications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/subscriptions/{subscriptionId}/notifications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/subscriptions/{subscriptionId}/notifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/subscriptions/{subscriptionId}/notifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions/{subscriptionId}/notifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/subscriptions/{subscriptionId}/notifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch notifications associated with this subscription

GET /subscriptions/{subscriptionId}/notifications

Return a paginated sortable filterable searchable collection of notifications. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        }
      }
    ]
  }
}

Responses

getNotificationsForTopic

Code samples

# You can also use wget
curl -X GET /notifications/topics/{topicId}/notifications \
  -H 'Accept: application/hal+json'

GET /notifications/topics/{topicId}/notifications HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/topics/{topicId}/notifications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/topics/{topicId}/notifications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/topics/{topicId}/notifications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/topics/{topicId}/notifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/topics/{topicId}/notifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/topics/{topicId}/notifications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch notifications associated with this topic

GET /topics/{topicId}/notifications

Return a paginated sortable filterable searchable collection of subscriptions. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/collection/notification/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "notifications",
  "_links": {
    "self": {
      "href": "/basePath/notifications?start=10&limit=10"
    },
    "first": {
      "href": "/basePath/notifications?start=0&limit=10"
    },
    "next": {
      "href": "/basePath/notifications?start=20&limit=10"
    },
    "collection": {
      "href": "/basePath/notifications"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "deliveryChannel": "web",
        "deliveryMethod": "pull"
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "http://api.apiture.com/schemas/notifications/notification/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/basePath/notifications/d62c0701-0d74-4836-83f9-ebf3709442ea"
          }
        },
        "deliveryChannel": "sms",
        "deliveryMethod": "push"
      }
    ]
  }
}

Responses

Subscription

Endpoints which facilitate the creation and modification of notification subscriptions.

getSubscriptions

Code samples

# You can also use wget
curl -X GET /notifications/subscriptions \
  -H 'Accept: application/hal+json'

GET /notifications/subscriptions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/subscriptions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/subscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of subscriptions

GET /subscriptions

Return a paginated sortable filterable searchable collection of subscriptions. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string",
  "_embedded": {
    "items": [
      {
        "deliveryChannel": "string",
        "deliveryMethod": "push",
        "endpoint": {
          "token": "string",
          "recipientUrl": "string"
        },
        "state": "inactive",
        "subscriberContent": {
          "email": "beto@apiture.com",
          "subject": "Hello Apiture"
        },
        "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "{uri of current resource}"
          }
        },
        "_id": "string",
        "authenticationState": "authenticated"
      }
    ]
  }
}

Responses

createSubscription

Code samples

# You can also use wget
curl -X POST /notifications/subscriptions \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /notifications/subscriptions HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/subscriptions',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/notifications/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/notifications/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/notifications/subscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/notifications/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new subscription

POST /subscriptions

Create a new subscription associated with a topic. The endpoint field is not required, even if the deliveryMethod field is set to push. A push subscription with no endpoint field cannot be activated until it has an authenticated endpoint. Attempts to activate a push subscription with no valid endpoint will return an error. A subscription may include additional subscriber information (subscriberContent) such as an email address or a phone number if required by the delivery channel. A push subscription can be created with an endpoint property that is missing a value for its token property. The push subscription will remain unauthenticated and unusable until an authorization token is provided. The notifications API attempts an authentication request at the location specified in the endpoint property at the time of subscription creation. If the authentication attempt fails, creation of the subscription fails. A subscription must have a link named apiture:topic which contains the href of a valid topic instance, as well as an apiture:subscriber link containing a reference to the subscriber entity.

Body parameter

{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

Response Headers

activateSubscription

Code samples

# You can also use wget
curl -X POST /notifications/activeSubscriptions \
  -H 'Accept: application/hal+json'

POST /notifications/activeSubscriptions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/activeSubscriptions',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/activeSubscriptions',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/notifications/activeSubscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.post('/notifications/activeSubscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/activeSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/notifications/activeSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Activate a subscription

POST /activeSubscriptions

Changes the state of a subscription to active

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

deactivateSubscription

Code samples

# You can also use wget
curl -X POST /notifications/inactiveSubscriptions \
  -H 'Accept: application/hal+json'

POST /notifications/inactiveSubscriptions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/inactiveSubscriptions',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/inactiveSubscriptions',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/notifications/inactiveSubscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.post('/notifications/inactiveSubscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/inactiveSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/notifications/inactiveSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Deactivate a subscription

POST /inactiveSubscriptions

Changes the state of a subscription to inactive

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

getSubscription

Code samples

# You can also use wget
curl -X GET /notifications/subscriptions/{subscriptionId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /notifications/subscriptions/{subscriptionId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/notifications/subscriptions/{subscriptionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/notifications/subscriptions/{subscriptionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/notifications/subscriptions/{subscriptionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/notifications/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions/{subscriptionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/subscriptions/{subscriptionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this subscription

GET /subscriptions/{subscriptionId}

Return a HAL representation of this subscription resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

Response Headers

updateSubscription

Code samples

# You can also use wget
curl -X PUT /notifications/subscriptions/{subscriptionId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PUT /notifications/subscriptions/{subscriptionId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/notifications/subscriptions/{subscriptionId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/notifications/subscriptions/{subscriptionId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.put '/notifications/subscriptions/{subscriptionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.put('/notifications/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions/{subscriptionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/notifications/subscriptions/{subscriptionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this subscription

PUT /subscriptions/{subscriptionId}

Perform a complete replacement of the subscription. Modifying the contents of the endpoint property will trigger the notification service to re-validate the subscription with the new endpoint attributes. This may cause the authenticationState of the subscription to change. For example, if the modified authentication token is invalid, the authenticationState will transition to "unauthenticated".

Updating the subscription may not alter existing in-process deliveries.

Body parameter

{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

Response Headers

patchSubscription

Code samples

# You can also use wget
curl -X PATCH /notifications/subscriptions/{subscriptionId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PATCH /notifications/subscriptions/{subscriptionId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/notifications/subscriptions/{subscriptionId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/notifications/subscriptions/{subscriptionId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.patch '/notifications/subscriptions/{subscriptionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.patch('/notifications/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions/{subscriptionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/notifications/subscriptions/{subscriptionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this subscription

PATCH /subscriptions/{subscriptionId}

Perform a partial update of this subscription. Fields which are omitted notification service to re-validate the subscription with the new endpoint attributes. This may cause the authenticationState of the subscription to change. For example, if the modified authentication token is invalid, the authenticationState will transition to "unauthenticated".

Updating the subscription may not alter existing in-process deliveries.

Body parameter

{
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "inactive",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/notifications/subscription/v0.1.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "deliveryMethod": "pull",
  "deliveryChannel": "SMS",
  "state": "active",
  "endpoint": {
    "token": "8BE74E2B956A9532D3534A835EB66",
    "recipientUrl": "http://somedomain.com/an/external/endpoint"
  },
  "subscriberContent": {
    "smsNumber": "555-555-5555"
  },
  "_links": {
    "apiture:topic": {
      "href": "https://api.apiture.com/notifications/topics/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    },
    "apiture:subscriber": {
      "href": "https://api.apiture.com/accounts/account/ef967d9f-8bf5-412e-ba31-7d9047cb96b4"
    }
  }
}

Responses

Response Headers

deleteSubscription

Code samples

# You can also use wget
curl -X DELETE /notifications/subscriptions/{subscriptionId} \
  -H 'Accept: application/hal+json'

DELETE /notifications/subscriptions/{subscriptionId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/subscriptions/{subscriptionId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/subscriptions/{subscriptionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/notifications/subscriptions/{subscriptionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/notifications/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/subscriptions/{subscriptionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/notifications/subscriptions/{subscriptionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete a subscription

DELETE /subscriptions/{subscriptionId}

Delete a subscription resource. Note that deleting a subscription may not cancel any associated notifications that the notifications service is actively processing. Active subscriptions can be deleted. There is no need to deactivate a subscription before deleting it.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

400 Response

{
  "_profile": "http://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.637Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Topic

Endpoints which facilitate the creation and modification of notification topics.

getTopics

Code samples

# You can also use wget
curl -X GET /notifications/topics \
  -H 'Accept: application/hal+json'

GET /notifications/topics HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/notifications/topics',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/notifications/topics',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/notifications/topics',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/notifications/topics', params={

}, headers = headers)

print r.json()

URL obj = new URL("/notifications/topics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/notifications/topics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Retrieve a collection of topics

GET /topics

Return a paginated sortable filterable searchable collection of topics. The links in the response include pagination links.

Parameters