Dates v0.7.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 Dates API provides various operations relating to calendars and dates. For example, the /eventDates
method can be used to find upcoming events given one or more schedules and a calendar of exclusions.
Download OpenAPI Definition (YAML)
Base URLs:
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the
API-Key: {api-key}
request header.
Event Dates
List of Event Dates
findEventDates
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/dates/eventDates \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/json' \
-H 'API-Key: API_KEY'
POST https://api.devbank.apiture.com/dates/eventDates HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/json
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/dates/eventDates',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"schedules": [
{
"label": "Retirement savings transfer",
"start": "2020-01-29T15:00:00.00Z",
"every": "P14D",
"count": 5,
"skippedCount": 0,
"maximumCount": 10,
"skipNext": true,
"end": "2019-08-01"
}
],
"exclusions": {
"holidays": [
"2019-12-24",
"2019-12-25"
],
"unprocessableDays": [
"sunday",
"saturday"
]
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/json',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/dates/eventDates',
{
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/json',
'API-Key' => 'API_KEY'
}
result = RestClient.post 'https://api.devbank.apiture.com/dates/eventDates',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/json',
'API-Key': 'API_KEY'
}
r = requests.post('https://api.devbank.apiture.com/dates/eventDates', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/dates/eventDates");
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/json"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/dates/eventDates", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of event dates
POST /eventDates
Finds upcoming event dates given one or more schedules of events and exclusions. Available parameters include start
, limit
, startDate
, and period
. There are two modes of pagination available:
- Indexed pages defined by a
start
index and alimit
period
based pagination beginning atstartDate
Only one mode of pagination can be used at a time and the default mode is period
with a value of P1Y
.
To obtain the next page of results, use the next
link in the response (if it exists) with a POST
verb. Pass the same request body as passed to this operation (this operation is fully stateless). If there is no next
link, the collection has been exhausted. Note that some queries may not have a terminating collection (for example, if the schedule does not have a start date). The service will update the query parameters in the link to access the next page, according to the type of pagination in use. Thait is, it will increment the start
if initially invoked with indexed-based pagination, or it will adjust the startDate
if initially invoked with period-based pagination. The limit
passed to this operation will also be passed to the next
page.
Body parameter
{
"schedules": [
{
"label": "Retirement savings transfer",
"start": "2020-01-29T15:00:00.00Z",
"every": "P14D",
"count": 5,
"skippedCount": 0,
"maximumCount": 10,
"skipNext": true,
"end": "2019-08-01"
}
],
"exclusions": {
"holidays": [
"2019-12-24",
"2019-12-25"
],
"unprocessableDays": [
"sunday",
"saturday"
]
}
}
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first event date item to include in this page. The default 0 denotes the beginning of the collection. If startDate is also provided start will be ignored. |
limit (query) |
integer(int32) The maximum number of event dates to return in this page. If period is also provided, limit will be ignored. Default: 100 |
startDate (query) |
string(date) The start date of the period in which to look for events. If period pagination mode is being used and no startDate is provided, the current date will be used. startDate will override start if both are provided. |
period (query) |
string The length of time used to paginate event date results. period will override limit if both are provided. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the number of years/months/days between dates. For example, use P7D to paginate by weeks, P2M to paginate by 2 months. Time values in period are ignored but may be honored in the future. Default: "P1Y" |
body (body) |
eventDatesRequest (required) The data necessary to find event dates. |
Try It
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/dates/eventDates/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/dates/eventDates?start=0&limit=5"
},
"first": {
"href": "/dates/eventDates?start=0&limit=5"
},
"next": {
"href": "/dates/eventDates?start=5&limit=5"
},
"collection": {
"href": "/dates/eventDates"
}
},
"start": 0,
"limit": 5,
"count": 28,
"name": "eventDates",
"_embedded": {
"items": {
"0": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-14"
},
"1": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-16"
},
"2": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-18"
},
"3": {
"labels": {
"0": "Core Schedule",
"1": "Second Schedule"
},
"date": "2019-06-20"
},
"4": {
"labels": {
"0": "Core Schedule",
"1": "Second Schedule"
},
"date": "2019-06-22"
}
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: eventDates |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
API
The Dates API
getApi
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/dates/ \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/dates/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/dates/',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/dates/',
{
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',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/dates/',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/dates/', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/dates/");
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"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/dates/", 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. Links included in this response include:
apiture:findEventDates
- aPOST
operation for finding dates corresponding to recurring scheduled events
Try It
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
}
},
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0"
}
Responses
getApiDoc
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/dates/apiDoc \
-H 'Accept: application/json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/dates/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
var headers = {
'Accept':'application/json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/dates/apiDoc',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/dates/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',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/dates/apiDoc',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/dates/apiDoc', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/dates/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"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/dates/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
Example responses
200 Response
{}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: Inline |
Response Schema
Schemas
abstractRequest
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
"_links": {}
}
Abstract Request (v2.0.0)
An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error
defined in abstractResource
.
This schema was resolved from common/abstractRequest
.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
abstractResource
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
}
}
}
Abstract Resource (v2.0.0)
An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links
, and either optional domain object data with _profile
and optional _embedded
objects, or an _error
object. In responses, if the operation was successful, this object will not include the _error
, but if the operation was a 4xx or 5xx error, this object will not include _embedded
or any data fields, only _error
and optionally _links
.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
|
attributeValue
{}
Attribute Value (v2.0.0)
The data associated with this attribute.
Properties
attributes
{
"property1": {},
"property2": {}
}
Attributes (v2.0.0)
An optional map of name/value pairs which contains additional dynamic data about the resource.
Properties
Name | Description |
---|---|
additionalProperties | attributeValue The data associated with this attribute. |
calendar
{
"holidays": [
"2019-12-24",
"2019-12-25"
],
"unprocessableDays": [
"sunday",
"saturday"
]
}
Calendar (v1.0.0)
A definition of a calendar.
Properties
Name | Description |
---|---|
holidays | [string] (required) A collection of dates on which events cannot occur. These dates should be in the RFC 3339 format, yyyy-mm-dd .
uniqueItems: true
|
unprocessableDays | [string] (required) A collection of days of the week on which events cannot occur. uniqueItems: true
|
collection
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
}
}
}
Collection (v2.0.0)
A collection of resources. This is an abstract model schema which is extended to define specific resource collections.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
|
count | integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
start | integer The start index of this page of items. |
limit | integer The maximum number of items per page. |
name | string The name of the collection. |
error
{
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
}
Error (v2.0.0)
Describes an error in an API request or in a service called via the API.
Properties
Name | Description |
---|---|
message | string (required) A localized message string describing the error condition. |
_id | string A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string. read-only
|
statusCode | integer The HTTP status code associate with this error. minimum: 100
maximum: 599
|
type | string An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode . For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet .
|
occurredAt | string(date-time) An RFC 3339 UTC time stamp indicating when the error occurred. |
attributes | attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type .
|
remediation | string An optional localized string which provides hints for how the user or client can resolve the error. |
errors | [error] An optional array of nested error objects. This property is not always present. |
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
errorResponse
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
}
},
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"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": "2018-01-25T05:50:52.375Z",
"_links": {
"describedby": {
"href": "https://api.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": {}
}
}
}
Error Response (v2.0.0)
Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error
object contains the error details.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
|
eventDate
{
"labels": [
"string"
],
"date": "2019-04-05"
}
Event Date (v1.0.0)
A date and one or more events that occur on that date. The labels
property will reference the associated schedules.
Properties
Name | Description |
---|---|
labels | [string] (required) The text label for this event, suitable for presentation to the client. This label references the one or more associated schedules.
|
date | string(date) (required) This date is in the ISO 8601 Date format, yyyy-mm-dd .
|
eventDates
{
"_profile": "https://production.api.apiture.com/schemas/dates/eventDates/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/dates/eventDates?start=0&limit=5"
},
"first": {
"href": "/dates/eventDates?start=0&limit=5"
},
"next": {
"href": "/dates/eventDates?start=5&limit=5"
},
"collection": {
"href": "/dates/eventDates"
}
},
"start": 0,
"limit": 5,
"count": 28,
"name": "eventDates",
"_embedded": {
"items": {
"0": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-14"
},
"1": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-16"
},
"2": {
"labels": {
"0": "Core Schedule"
},
"date": "2019-06-18"
},
"3": {
"labels": {
"0": "Core Schedule",
"1": "Second Schedule"
},
"date": "2019-06-20"
},
"4": {
"labels": {
"0": "Core Schedule",
"1": "Second Schedule"
},
"date": "2019-06-22"
}
}
}
}
Event Date Collection (v1.0.0)
Collection of event dates. The items in the collection are ordered in the _embedded
object with name items
. The top-level _links
object may contain pagination links (self
, next
, prev
, first
, last
, collection
). These pagination links require using POST
and should pass the same Event Dates Request object as described in the findEventsDate
operation.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object Embedded objects. |
ยป items | [eventDate] An array containing a page of event dates. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
|
count | integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
start | integer The start index of this page of items. |
limit | integer The maximum number of items per page. |
name | string The name of the collection. |
startDate | string The start date of events on this page. |
period | string The length of time used to paginate event date results. |
eventDatesRequest
{
"schedules": [
{
"label": "Retirement savings transfer",
"start": "2020-01-29T15:00:00.00Z",
"every": "P14D",
"count": 5,
"skippedCount": 0,
"maximumCount": 10,
"skipNext": true,
"end": "2019-08-01"
}
],
"exclusions": {
"holidays": [
"2019-12-24",
"2019-12-25"
],
"unprocessableDays": [
"sunday",
"saturday"
]
}
}
Event Dates Request (v1.0.0)
The request body for invoking /eventDates
. Contains an array of scheduled events and a calendar representing excluded dates.
Properties
Name | Description |
---|---|
schedules | [schedule] (required) A list of one or more schedules for the event. minLength: 1
|
exclusions | calendar A definition of a calendar. |
link
{
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Application"
}
Link (v1.0.0)
Describes a hypermedia link within a _links
object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name
or hreflang
properties of HAL. Apiture links may include a method
property.
This schema was resolved from common/link
.
Properties
Name | Description |
---|---|
href | string(uri) (required) The URI or URI template for the resource/operation this link refers to. |
type | string The media type for the resource. |
templated | boolean If true, the link's href is a URI template. |
title | string An optional human-readable localized title for the link. |
deprecation | string(uri) If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation. |
profile | string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. |
links
{
"property1": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Application"
},
"property2": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Application"
}
}
Links (v1.0.0)
An optional map of links, mapping each link relation to a link object. This model defines the _links
object of HAL representations.
This schema was resolved from common/links
.
Properties
Name | Description |
---|---|
additionalProperties | link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from |
root
{
"_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
}
},
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0"
}
API Root (v2.0.0)
A HAL response, with hypermedia _links
for the top-level resources and operations in API.
Properties
Name | Description |
---|---|
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | object An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | string(uri) The URI of a resource profile which describes the representation. read-only
|
_error | error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
|
_id | string This API's unique ID. read-only
|
name | string This API's name. |
apiVersion | string This API's version. |
schedule
{
"label": "Retirement savings transfer",
"start": "2020-01-29T15:00:00.00Z",
"every": "P14D",
"count": 5,
"skippedCount": 0,
"maximumCount": 10,
"skipNext": true,
"end": "2019-08-01"
}
Schedule (v1.0.0)
A definition for a one-time or recurring scheduled event.
Properties
Name | Description |
---|---|
label | string (required) The text label for this schedule, suitable for presentation to the client. Events will use this label to reference a schedule.
|
start | string(date-time) When the event occurs, or when a recurring event begins. This is a date-time in RFC 3339 yyyy-mm-ddTHH:MM:SSZ format. If present, the time portion is a hint; the financial institution may not be able to schedule events at specific times. If start is not provided, the current date will be used. If start is after the end of processing for the current day, the event may be scheduled for the next processing day.
|
every | string The every period indicates the interval at which the event recurs, such as every week, every month, every 3 months. If omitted or empty, this event is a one-time event. every is required if either maximumCount is greater than 1 or if end is greater than start . This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the number of years/months/days between events. For example, use P7D to schedule every week, P2M to schedule every other month, P4Y to schedule every four years on the anniversary set by start . Time values in every are ignored but may be honored in the future. (That is, it is not possible to schedule an event every 8 hours; the minimum is P1D ). To specify semi-monthly or semi-annually, use P0.5M or P0.5Y . Fractional values are only allowed for month and year, and 0.5 is the only allowed fractional value. Some financial institutions may limit recurring events such that the period must be a year (P1Y , 'P12M, 'P365D ) or less. Scheduling may adjust event dates if start occurs near boundary dates which do occur not every year/month, such as start: "2019-01-31", every: "P1M" . For example, the next event may occur on the 30th for months which have only 30 days (Apr, Jun, Sep, Nov), or 29th or 28th for February. Actual event dates may also be adjusted to account for holidays or other days when processing does not occur.
|
count | integer For a recurring event, this is the number of events which have occurred. It is a derived value and ignored on updates. |
skippedCount | integer For a recurring event, this is the number of events which have been skipped, either because a processing date passed when a recurring event had a value of true for skipNext , or a recurring event was suspended. It is a derived value and ignored on updates.
|
maximumCount | integer The maximum number of events to schedule for a recurring event. (Events in the recurrence will stop if the current date is beyond that set by end , even if fewer than maximumCount events have occurred.) The every period is required if maximumCount or end is set. It is an error (422) if maximumCount is anything other than 0 or 1 and every is not set. If a schedule contains both end and maximumCount , the earliest will determine when the recurrence ends.
|
skipNext | boolean This field is ignored for one-time events. If true for recurring schedules, skip (do not schedule) the next event. After that instance is skipped, this field is reset to false (only one instance may be skipped). |
end | string(date) The optional date when the recurring event ends (inclusive). Events recur until the maximumCount of events are met or the next scheduled event is after the end date. (The earliest of maximumCount or end wins). If specified, end must be no earlier than start . This is a date in RFC 3339 yyyy-mm-dd format. When scheduling an event, the request should contain either |