Text v0.12.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.

Manage localizable and customizable text strings for client applications. The Text API is a repository for customizable and localizable text strings which the financial institution may wish to customize in order to change their user experience. The primary consumer of this API is client applications. Example of customizable text includes:

• page or form titles
• field labels
• hover tips
• URLs (for images or other resources)
• icon references in image icon sets
• instructions or other in-line help
• larger text blocks such as Markdown text blocks.

The Text API manages only static text that is part of the UX or clients, not dynamic changing text data (such as an banking product names, document names, description) provided by the services or the users.

Text Strings and Text String Groups

Text is organized into named groups of related strings. These groups often correspond to client application features, such as banking, transfers, or digital account opening. The special group name common represents content that is "common" to (or shared with) all other groups. Groups names may be nested logically. For example, the group common.fi is for text related to the financial institution within the common group. Text strings may include references to other strings, including strings in other groups. For example, consider the message string

Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportLink_url}}

This template resolve to a string result such as

Contact 3rd Party Bank customer support at 555-555-1234 or [Support](https://www3rdparty.bank/support)

{{common.fi.supportNumber}} is an example of a string reference to a tex string which consists of a group name (common.fi) and string name (supportNumber). Unresolved references are left unexpanded. For example, if there is no string named support_url in the common.fi group, the above text string request returns

Contact 3rd Party Bank customer support at 555-555-1234 or {{common.fi.supportLink_url}}

The reserved group name _ is an alias for the current group. This allows text strings to easily reference other text strings in the same group in a more concise manner.

For example, if the text string

Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportLink_url}}

exists in the common.fi group, it could be coded as

Contact {{_.name}} customer support at {{_.supportNumber}} or {{_.supportLink_url}}

By convention, string references without group names (that is, those with the format {{name}}) are not expanded by the Text service and are left for client-side expansion using a client-supplied environment map of name/value pairs. The same is true for references {{groupId.textStringId}} where the named group or string are not defined.)

Text strings are referenced by a string ID, which must be a simple name:

name = [ letter | "_" ] ( letter | digit | "_" | "$" )*
textStringId = name

Text string names may end with a _ and a suffix which indicates the purpose or use of the text string. The Text API supports the following suffixes:

• _label - labels for UI fields; allows Markdown (125)
• _tip - tool tips, hover tips; allows Markdown (250)
• _md - Markdown formatted text blocks, such as instructions. Possibly multi-line. (4000)
• _url - URLs of other resources, such as images. Example: backgroundImage_url (250)
• _help - Short on-screen Markdown help for (?) or (i) icons or Explain this buttons. (1000)

The maximum length of a text string is determined by the suffix (shown in parentheses above). Client applications must render Markdown text values before presenting *_label, *_md and *_help text strings to the user. Web applications may format Markdown to HTML for example.

A group ID is a simple name or .-separated names for two- or three-level names such as level1.level2.level3.

groupId = name ( "." name ) {0,2}

The concatenation of the group ID and a period and the string name is the string's key.

The service does not allow creating a group named local or starting with local.. Such groups are reserved for clients to resolve with client-local data.

Natural Language Support

Each text string can have different natural language variants, access by a language code. For example, a text string preferredAddressOption_label may have values for the RFC 3066 language identifiers es-MX, es-SP, fr, de, en-GB and en-US. The client specifies the preferred language when requesting text strings and The service follows locale inheritance rules when resolving the request. (See the GET /resolved (getResolvedText) operation below.)

For example, when asking for resolved text for es-MX, if a text string preferredAddressOption_label is not defined for es-MX, the service looks for a value for es, and if not defined for es, the service returns the value defined for the default locale. The default locale is en-US. The default locale-independent value for each text string must be defined when adding groups and text strings.

Presentation Format/Form Factors

Text also supports content that is specific to a format which represents different user experience form factors. A mobile app with a smaller screen format may require a different set of labels than those used for web or larger tablets. The service will also fall back from format-specific to format-agnostic labels.

The language and format are examples of optional text parameters.

The client can request text either by the URL path GET /groups/{groupId}/strings/{textStringId} or by requesting all text strings in one or more groups via GET /text/resolved?group=group1|group2|...|groupN or for all groups, GET /text/resolved. These operations support parameterization of the response with the ?format= query parameter and/or the ?languages= query parameter. Note that unlike many other Apiture APIs, the identifiers for groups and strings (groupId and textStringId) are names, not opaque resource IDs. Clients may use PUT to create or update new groups and new text strings within groups with client-supplied names rather than using POST to create resources and have the service generate the IDs.

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

cannotDefineLocalGroup

Description: Cannot define the group local or a group name starting with local..
Remediation: Use a non-reserved group name.

cannotUpdateImmutableGroup

Description: Cannot update an immutable group.
Remediation: Check the group ID and the group's immutable property and avoid updating an immutable group.

circularStringDefinition

Description: The request would result in text string definitions with circular text string references.
Remediation: Avoid circular references in text string definitions.

The attributes object in the error may have the following properties:

Property	Type	Description
cycle	[object]	The cycle of text strings objects.

duplicateStringValues

Description: The values in a text string may not have duplicates for language and format.
Remediation: Submit values without duplicates.

The attributes object in the error may have the following properties:

Property	Type	Description
stringId	string	The {textStringId} in the request URL.
format	string	The format property of the duplicated value, or '' if format was omitted.
language	string	The language property of the duplicated value, or '' if language was omitted.

invalidAcceptLanguage

Description: The Accept-Language request header is not well-formed.
Remediation: Resubmit the operation with a valid Accept-Language request header.

invalidFormat

Description: A string item format is invalid or is not found.
Remediation: String items must use format names that match existing formats in the getFormats collection. Format names must use the pattern ^[a-z][a-zA-Z0-9_$]{3,11}$.

invalidFormatQuery

Description: The format query parameter is not well-formed.
Remediation: Resubmit the operation with a valid format query parameter.

invalidGroupQuery

Description: The group query parameter is not well-formed.
Remediation: Resubmit the operation with a valid group query parameter.

invalidLanguage

Description: A string item language is invalid.
Remediation: String items must use RFC 3066 language identifiers that match the pattern ^[a-z]{2,3}(-[a-zA-Z0-9]{2,4})?$.

invalidLanguageQuery

Description: The language query parameter is not well-formed.
Remediation: Resubmit the operation with a valid language query parameter.

invalidString

Description: A string item name is invalid.
Remediation: Use a string item name that matches the pattern ^[a-z][a-zA-Z0-9_$]{0,32}$.

The attributes object in the error may have the following properties:

Property	Type	Description
name	string	The invalid string item name.

missingDefaultValues

Description: The text string's values' must have one default item with no languageorformat`.
Remediation: Provide a default value to use when the other values do not match the request language.

The attributes object in the error may have the following properties:

Property	Type	Description
stringId	string	The {textStringId} in the request URL.

missingStringItems

Description: A request to update an existing text string omitted an previously defined item corresponding to a format and/or language.
Remediation: Include all original string items when updating a text string, either replacing the value, or adding new items for new formats and/or languages.

The attributes object in the error may have the following properties:

Property	Type	Description
missingItems	[object]	The existing string items (format+language) which were omitted from the request.

nameDoesNotMatchPath

Description: The name in the request does not match the path parameter.
Remediation: Set the path parameter to match the value of name in the request body. When updating an existing item, use the self link.

stringNameMismatch

Description: The text string name does not match the URL path {textStringId}.
Remediation: The request body must concur with the {textStringId} in the URL.

The attributes object in the error may have the following properties:

Property	Type	Description
stringName	string	The name in the text string request body.
stringId	string	The {textStringId} in the request URL.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/text

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://auth.devbank.apiture.com/auth/oauth2/authorize
  • Token URL = https://api.devbank.apiture.com/auth/oauth2/token

Scope	Scope Description
data/read	Read access to text
admin/write	Write (update) access to text
admin/delete	Delete access to text
data/full	Full access to text

Text

Text

getResolvedText

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/resolved \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/resolved HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/resolved',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/resolved',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/resolved',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/resolved', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/resolved");
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"},
        "Accept-Language": []string{"string"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/resolved", data)
    req.Header = headers

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

GET https://api.devbank.apiture.com/text/resolved

Return all text groups and text strings for the specified (or default) language and the specified (or default) client format. The strings are resolved by replacing string references (references have the form {{key}}) to other text strings with their corresponding values. This operation is the primary operation that clients use to load the text strings to present to one end user, based on that user's preferred language and their device format.

Parameters

Parameter	Description
format in: query	string Return text strings that match the named or default format (form factor). If no text for the requested format exists for a textStringId, the default text for that textStringId is returned. minLength: 4 maxLength: 10 default: "small" pattern: "^[a-z][a-zA-Z0-9]{3,9}$"
languages in: query	array[string] Return text strings that match the search priority of the given language tag(s). The array is ordered by highest to lowest preference. For example, for ?languages=es-MX,en-GB, the response will include text strings based on the following search priority: es-MX ⇒ es ⇒ en-GB ⇒ en ⇒ `` (default) Items are RFC 3066 language identifiers. If used, Accept-Language header is ignored. Language codes are case insensitive. minItems: 1 maxItems: 6 comma-delimited items: string(language) » format: language » minLength: 2 » maxLength: 8 » pattern: "^[a-z]{2,3}(-[a-zA-Z0-9]{2,4})?$"
Accept-Language in: header	string An HTTP Accept-Language request header which specifies one or more languages with weights. The response will include one string for each combination of group name and string name. This is ignored if ?languages= query parameter is used. Accept-Language is processed in a similar way as the language query parameter.
groups in: query	array[string] Subset the response to only text in the group or groups named in this parameter. Each item in the comma-separated list is a one-, two-, or three-level group name. Group names are case sensitive. The default is ?groups=common. Example: &groups=common,help,features.x,feature.y. minItems: 1 comma-delimited items: string » minLength: 2 » maxLength: 128 » pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"
since in: query	string(date-time) Return only text strings whose updatedAt time-stamp are newer than the since date-time. If omitted, return all text strings The value is an RFC 3339 time stamp in YYYY-MM-DDThh:mm:ss.sssZ format. format: date-time
resolve in: query	boolean If ?resolve=false, this operation does not resolve embedded {{key}} text string references. default: true
subgroups in: query	boolean If true, the response includes all subgroups of each group named in groups. This example may return the groups common and common.fi, common.print, and web.responsive but not the groups commonTrust or helpless. default: true
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/resolvedStrings/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "format": "large",
  "languages": [
    "en-US",
    "en"
  ],
  "groups": {
    "common": {
      "greeting": "Welcome, {{user.preferredName}}"
    },
    "common.fi": {
      "name": "3rd Party Bank",
      "supportNumber": "555-555-1234",
      "support_url": "https://www3rdparty.bank/support",
      "supportLink_md": "[Support](https://www3rdparty.bank/support)",
      "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
      "help_md": "For help, please visit [Our help page]({{common.fi.helpUrl}})"
    },
    "checkDeposit": {
      "title": "Remote Check Deposit",
      "scanFront": "Take an image of the front of the check",
      "scanBack": "Take an image of the back of the check"
    }
  },
  "unresolvedKeys": [
    "common.fi.helpUrl",
    "user.preferredName"
  ]
}

Responses

Text String

Text String

getStrings

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId}/strings \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/groups/{groupId}/strings HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}/strings',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/groups/{groupId}/strings', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/groups/{groupId}/strings", data)
    req.Header = headers

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

Return a collection of text strings

GET https://api.devbank.apiture.com/text/groups/{groupId}/strings

Return a collection of text strings within the group. Since the number of text strings in a group is relatively small, this operation does not implement pagination, sorting, filtering, or searching.

Parameters

Parameter	Description
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/textStrings/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi/strings"
    }
  },
  "name": "strings",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_embedded": {
    "items": [
      {
        "name": "supportNumber",
        "values": [
          {
            "value": "(910) 999-9999",
            "format": "small"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportNumber"
          }
        }
      },
      {
        "name": "support_url",
        "values": [
          {
            "value": "https://www.3rdparty.bank/support",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/es/support",
            "language": "es",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/fr/support",
            "language": "fr",
            "format": "small"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportUrl"
          }
        }
      }
    ]
  }
}

Responses

getString

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Fetch a representation of this text string

GET https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}

Return a HAL representation of this text string resource.

Parameters

Parameter	Description
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"
textStringId in: path	string (required) The unique identifier (name) of this text string. minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9_$]{1,63}$"

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "contactSupport",
  "description": "Instructions for a user to contact the financial institution's support via phone or email.",
  "updatedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.support_url}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.support_url}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.support_url}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Responses

setString

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "contactSupport",
  "description": "Instructions for a user to contact the financial institution's support via phone or email.",
  "updatedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.support_url}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.support_url}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.support_url}}",
      "format": "small",
      "language": "fr"
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  method: 'put',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}");
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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Create or update a text string

PUT https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}

Create a new text with the textStringId name if one did not already exist, or update the properties of an existing text string. This operation is limited to administrative use.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "contactSupport",
  "description": "Instructions for a user to contact the financial institution's support via phone or email.",
  "updatedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.support_url}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.support_url}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.support_url}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	textString (required) A text string and variants for different languages and client formats.
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"
textStringId in: path	string (required) The unique identifier (name) of this text string. minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9_$]{1,63}$"

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "contactSupport",
  "description": "Instructions for a user to contact the financial institution's support via phone or email.",
  "updatedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.support_url}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.support_url}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.support_url}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Responses

deleteString

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com

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

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'DELETE',

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

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}");
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{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Delete this text string resource

DELETE https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}

Delete this text string resource and any resources that are owned by it. This operation is limited to administrative use.

Parameters

Parameter	Description
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"
textStringId in: path	string (required) The unique identifier (name) of this text string. minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9_$]{1,63}$"

Responses

Text Group

Group of Text Strings

getGroups

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/groups HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/groups',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/groups", data)
    req.Header = headers

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

Return a collection of text groups

GET https://api.devbank.apiture.com/text/groups

Return the collection of text groups. Since the number of groups is relatively small, this operation does not implement pagination, sorting, filtering, or searching.

Parameters

Parameter	Description
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/groups/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups"
    }
  },
  "name": "groups",
  "start": 0,
  "limit": 32,
  "count": 32,
  "_embedded": {
    "items": [
      {
        "name": "common.fi",
        "description": "General text which pertains to the financial institution.",
        "immutable": false,
        "updatedAt": "2019-11-18T11:23:16.375Z",
        "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi"
          }
        }
      },
      {
        "name": "help",
        "description": "Strings that represents in-application help text, such as tool tips.",
        "immutable": false,
        "updatedAt": "2019-11-20T12:36:02.375Z",
        "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/help"
          }
        }
      }
    ]
  }
}

Responses

getGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/groups/{groupId}", data)
    req.Header = headers

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

Fetch a representation of this text group

GET https://api.devbank.apiture.com/text/groups/{groupId}

Return a HAL representation of this text group resource.

Parameters

Parameter	Description
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  },
  "name": "common.fi",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "updatedAt": "2019-11-18T11:23:16.375Z"
}

Responses

setGroup

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/text/groups/{groupId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  },
  "name": "common.fi",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "updatedAt": "2019-11-18T11:23:16.375Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'put',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/text/groups/{groupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}");
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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/text/groups/{groupId}", data)
    req.Header = headers

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

Create or update a text group

PUT https://api.devbank.apiture.com/text/groups/{groupId}

Create a text group, or update an existing text group's properties.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  },
  "name": "common.fi",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "updatedAt": "2019-11-18T11:23:16.375Z"
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	group (required)
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  },
  "name": "common.fi",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "updatedAt": "2019-11-18T11:23:16.375Z"
}

Responses

deleteGroup

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/text/groups/{groupId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com

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

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}',
{
  method: 'DELETE',

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

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/text/groups/{groupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}");
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{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/text/groups/{groupId}", data)
    req.Header = headers

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

Delete this text group resource

DELETE https://api.devbank.apiture.com/text/groups/{groupId}

Delete this text group resource and any resources that are owned by it.

Parameters

Parameter	Description
groupId in: path	string (required) The unique identifier (name) of this text group. minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"

Responses

Text Format

Target Client Text Formats

getFormats

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/formats \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/formats HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/formats',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/formats',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/formats',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/formats', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/formats");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/formats", data)
    req.Header = headers

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

Return a collection of text formats

GET https://api.devbank.apiture.com/text/formats

Return a collection of text formats. The Text service has default formats named small and large.

Parameters

Parameter	Description
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/formats/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/formats"
    }
  },
  "name": "formats",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_embedded": {
    "items": [
      {
        "name": "small",
        "description": "Small or limited screen real estate, such as a hand held smartphone.",
        "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/small"
          }
        }
      },
      {
        "name": "large",
        "description": "A large format device with generous screen real estate, such as a desktop or laptop application or browser.",
        "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/large"
          }
        }
      }
    ]
  }
}

Responses

getFormat

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/formats/{formatId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/formats/{formatId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/text/formats/{formatId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/formats/{formatId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/formats/{formatId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/text/formats/{formatId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/formats/{formatId}");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/text/formats/{formatId}", data)
    req.Header = headers

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

Fetch a representation of this text format

GET https://api.devbank.apiture.com/text/formats/{formatId}

Return a HAL representation of this text format resource.

Parameters

Parameter	Description
formatId in: path	string (required) The unique identifier (name) of this text format. minLength: 4 maxLength: 10 pattern: "^[a-z][a-zA-Z0-9]{3,9}$"
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone."
}

Responses

setFormat

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/text/formats/{formatId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/text/formats/{formatId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone."
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/formats/{formatId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/formats/{formatId}',
  method: 'put',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/text/formats/{formatId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/text/formats/{formatId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/formats/{formatId}");
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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/text/formats/{formatId}", data)
    req.Header = headers

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

Update or create a text format

PUT https://api.devbank.apiture.com/text/formats/{formatId}

Perform a complete replacement of this text format.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone."
}

Parameters

Parameter	Description
formatId in: path	string (required) The unique identifier (name) of this text format. minLength: 4 maxLength: 10 pattern: "^[a-z][a-zA-Z0-9]{3,9}$"
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	format (required)

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone."
}

Responses

API

The Text API

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/text/',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/text/',
  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/text/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/");
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/text/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/text/

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.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/text/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/text/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/text/apiDoc',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/apiDoc',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/text/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/text/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/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/text/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET https://api.devbank.apiture.com/text/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/"
    }
  }
}

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
Abstract Request (v2.0.0)	object 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.
_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 common/links.
_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 format: uri

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Abstract Resource (v2.1.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.

This schema was resolved from common/abstractResource.

Properties

Name	Description
Abstract Resource (v2.1.0)	object 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. This schema was resolved from common/abstractResource.
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

attributes

{}

Attributes (v2.1.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

Name	Description
Attributes (v2.1.0)	object An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Collection (v2.1.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/collection.

Properties

Name	Description
Collection (v2.1.0)	object A collection of resources. This is an abstract model schema which is extended to define specific resource collections. This schema was resolved from common/collection.
_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 common/links.
_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 format: uri
_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.1.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

Name	Description
Error (v2.1.0)	object Describes an error in an API request or in a service called via the API. This schema was resolved from common/error.
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. format: date-time
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. Additional Properties: true
remediation	string An optional localized string which provides hints for how the user or client can resolve the error.
errors	array: [error] An optional array of nested error objects. This property is not always present. items: object

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.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": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.1.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

Name	Description
Error Response (v2.1.0)	object Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details. This schema was resolved from common/errorResponse.
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

format

{
  "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone."
}

Text Format (v1.1.0)

Representation of text format resources. Text formats represent client-side presentation formats, such as small for a display with limited screen real estate, or large for a display with generous screen real estate. The text service supports small and large, and small is the default format.

Properties

Name	Description
Text Format (v1.1.0)	object Representation of text format resources. Text formats represent client-side presentation formats, such as small for a display with limited screen real estate, or large for a display with generous screen real estate. The text service supports small and large, and small is the default format.
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string (required) The name of this text format. This is the format ID. Names are case sensitive. type: string minLength: 4 maxLength: 10 pattern: "^[a-z][a-zA-Z0-9]{3,9}$"
description	string (required) The description of this text string format. minLength: 8 maxLength: 256

formats

{
  "_profile": "https://production.api.apiture.com/schemas/text/formats/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/formats"
    }
  },
  "name": "formats",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_embedded": {
    "items": [
      {
        "name": "small",
        "description": "Small or limited screen real estate, such as a hand held smartphone.",
        "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/small"
          }
        }
      },
      {
        "name": "large",
        "description": "A large format device with generous screen real estate, such as a desktop or laptop application or browser.",
        "_profile": "https://production.api.apiture.com/schemas/text/format/v1.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/large"
          }
        }
      }
    ]
  }
}

Text Format Collection (v1.1.0)

Collection of text formats. The items in the collection are ordered in the _embedded.items array; the name is formats. This collection is small and thus does not support pagination links.

Properties

Name	Description
Text Format Collection (v1.1.0)	object Collection of text formats. The items in the collection are ordered in the _embedded.items array; the name is formats. This collection is small and thus does not support pagination links.
_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 common/links.
_embedded	object Embedded objects.
» items	array: [format] An array containing text format items. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_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.

group

{
  "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  },
  "name": "common.fi",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "updatedAt": "2019-11-18T11:23:16.375Z"
}

Text Group (v1.2.0)

A text group is a named set of related text strings.

Links

Response and request bodies using this group schema may contain the following links:

Rel	Summary	Method
self	Fetch a representation of this text group	GET

Properties

Name	Description
Text Group (v1.2.0)	object A text group is a named set of related text strings. Links Response and request bodies using this group schema may contain the following links: Rel Summary Method self Fetch a representation of this text group GET
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string (required) The name of this text group. This is the group ID. The name of a group is a simple identifier name such as common (up to 16 alphanumeric characters) or a two- or three-level name such as common.fi or address.line1Label where each level name is a simple identifier of 1 to 16 alphanumeric characters. Group names are case sensitive minLength: 2 maxLength: 128 pattern: "^[a-z][a-zA-Z0-9_$]{0,41}(\\.[a-z][a-zA-Z0-9_$]{0,41}){0,2}$"
description	string (required) The description of this text string format. minLength: 8 maxLength: 256
immutable	boolean This group is immutable. default: false
updatedAt	string(date-time) The date-time when this group (or any text strings in it) was last modified. This is in RFC 3339 UTC format. read-only format: date-time

groups

{
  "_profile": "https://production.api.apiture.com/schemas/text/groups/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups"
    }
  },
  "name": "groups",
  "start": 0,
  "limit": 32,
  "count": 32,
  "_embedded": {
    "items": [
      {
        "name": "common.fi",
        "description": "General text which pertains to the financial institution.",
        "immutable": false,
        "updatedAt": "2019-11-18T11:23:16.375Z",
        "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi"
          }
        }
      },
      {
        "name": "help",
        "description": "Strings that represents in-application help text, such as tool tips.",
        "immutable": false,
        "updatedAt": "2019-11-20T12:36:02.375Z",
        "_profile": "https://production.api.apiture.com/schemas/text/group/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/help"
          }
        }
      }
    ]
  }
}

Text Group Collection (v1.2.0)

Collection of text groups. The items in the collection are ordered in the _embedded.items array; the name is groups.

Properties

Name	Description
Text Group Collection (v1.2.0)	object Collection of text groups. The items in the collection are ordered in the _embedded.items array; the name is groups.
_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 common/links.
_embedded	object Embedded objects.
» items	array: [group] An array containing text group items. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_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.

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
Link (v1.0.0)	object 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.
href	string(uri) (required) The URI or URI template for the resource/operation this link refers to. format: uri
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. format: uri
profile	string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. format: uri

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
Links (v1.0.0)	object 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.
Link (v1.0.0)	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 common/link.

resolvedGroup

{
  "name": "3rd Party Bank",
  "supportNumber": "555-555-1234",
  "support_url": "https://www3rdparty.bank/support",
  "supportLink_md": "[Support](https://www3rdparty.bank/support)",
  "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
  "help_md": "For more help, please visit [Our help page](https://www3rdparty.bank/help)"
}

Resolved Group (v1.1.0)

A resolved group of text string values for a specific language or set of languages and format. The keys in this object are group IDs such as common, common.fi, or checkDeposit. The values map string IDs to simple strings objects, with any resolvable text string references replaced by their values. In the example below, there is no text string user.preferredName so it is left unresolved.

Properties

Name	Description
Resolved Group (v1.1.0)	object A resolved group of text string values for a specific language or set of languages and format. The keys in this object are group IDs such as common, common.fi, or checkDeposit. The values map string IDs to simple strings objects, with any resolvable text string references replaced by their values. In the example below, there is no text string user.preferredName so it is left unresolved.
additionalProperties	string

resolvedStrings

{
  "_profile": "https://production.api.apiture.com/schemas/text/resolvedStrings/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "format": "large",
  "languages": [
    "en-US",
    "en"
  ],
  "groups": {
    "common": {
      "greeting": "Welcome, {{user.preferredName}}"
    },
    "common.fi": {
      "name": "3rd Party Bank",
      "supportNumber": "555-555-1234",
      "support_url": "https://www3rdparty.bank/support",
      "supportLink_md": "[Support](https://www3rdparty.bank/support)",
      "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
      "help_md": "For help, please visit [Our help page]({{common.fi.helpUrl}})"
    },
    "checkDeposit": {
      "title": "Remote Check Deposit",
      "scanFront": "Take an image of the front of the check",
      "scanBack": "Take an image of the back of the check"
    }
  },
  "unresolvedKeys": [
    "common.fi.helpUrl",
    "user.preferredName"
  ]
}

Resolved Strings (v1.1.0)

Resolved text string items for a specific language or set of languages and format. This contains groups which is a map of maps. The outer map has group names as keys and inner maps as values; the inner maps have text string names as keys and raw string values as the values. These are very light-weight representations if groups and text strings.

Properties

Name	Description
Resolved Strings (v1.1.0)	object Resolved text string items for a specific language or set of languages and format. This contains groups which is a map of maps. The outer map has group names as keys and inner maps as values; the inner maps have text string names as keys and raw string values as the values. These are very light-weight representations if groups and text strings.
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
format	string (required) The value of the format query parameter (or the default) used when requesting the resolved text. minLength: 4 maxLength: 10 pattern: "^[a-z][a-zA-Z0-9]{3,9}$"
languages	array: [string] (required) The language(s) from which the returned text strings are resolved. items: string
groups	object The map of group IDs to resolved strings in that group.
» Resolved Group (v1.1.0)	resolvedGroup A resolved group of text string values for a specific language or set of languages and format. The keys in this object are group IDs such as common, common.fi, or checkDeposit. The values map string IDs to simple strings objects, with any resolvable text string references replaced by their values. In the example below, there is no text string user.preferredName so it is left unresolved.
unresolvedKeys	array: [string] A list of string keys (groupId + . + textStringId) which were referenced in groups strings but which are not resolved either because the groupId was not defined, or the textStringId was not defined in the group named by the key. items: string

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.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.1.0)

A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

Properties

Name	Description
API Root (v2.1.0)	object A HAL response, with hypermedia _links for the top-level resources and operations in API. This schema was resolved from common/root.
_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 common/links.
_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 format: uri
_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.

textString

{
  "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "name": "contactSupport",
  "description": "Instructions for a user to contact the financial institution's support via phone or email.",
  "updatedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.support_url}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.support_url}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.support_url}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.support_url}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Text String (v1.3.0)

A named text string within a group. Each text string contains one or more values, parameterized by an optional language code and format code. Items without a language and format serve as default values which are used if no item matches the requested language and format. The text string's values must include exactly one default item with no language and format. No two values may have the same format and language.

Links

Response and request bodies using this textString schema may contain the following links:

Rel	Summary	Method
self	Fetch a representation of this text string	GET
apiture:group	Fetch a representation of this text group	GET

Properties

Name	Description
Text String (v1.3.0)	object A named text string within a group. Each text string contains one or more values, parameterized by an optional language code and format code. Items without a language and format serve as default values which are used if no item matches the requested language and format. The text string's values must include exactly one default item with no language and format. No two values may have the same format and language. Links Response and request bodies using this textString schema may contain the following links: Rel Summary Method self Fetch a representation of this text string GET apiture:group Fetch a representation of this text group GET
_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 common/links.
_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 format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string (required) The name of this text string. The name must be unique within the group. minLength: 2 maxLength: 64 pattern: "^[a-z][a-zA-Z0-9_$]{1,63}$"
description	string A description of what this text string represents and how it is used in applications. This aids tools that allow editing the text string. maxLength: 256
values	array: [textStringItem] (required) String values for each combination of format and language. items: object
updatedAt	string(date-time) The date-time when this text string was last modified. This is in RFC 3339 UTC format. read-only format: date-time

textStringItem

{
  "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.support_url}}",
  "format": "large",
  "language": "fr"
}

Text String Item (v1.1.0)

A since string value, corresponding to a textStringId, language code, and a format code. One or more text string items form a textString object with a shared textStringId.

Properties

Name	Description
Text String Item (v1.1.0)	object A since string value, corresponding to a textStringId, language code, and a format code. One or more text string items form a textString object with a shared textStringId.
value	string (required) The text value of this string. maxLength: 4096
language	string(language) The RFC 3066 language identifier for this string item. If omitted on this instance, this is a default text string item to be used if no other items match a request. Language codes are case insensitive. format: language minLength: 2 maxLength: 8 pattern: "^[a-z]{2,3}(-[a-zA-Z0-9]{2,4})?$"
format	string The name of a format (or form factor) of the client user experience that this string item best matches. If omitted, this is a default string item to be used if no other items match a request. If specified, this must be the ID of a format resource at /text/formats/{formatId}, such as small or large. minLength: 4 maxLength: 10 pattern: "^[a-z][a-zA-Z0-9]{3,9}$"

textStrings

{
  "_profile": "https://production.api.apiture.com/schemas/text/textStrings/v1.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi/strings"
    }
  },
  "name": "strings",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_embedded": {
    "items": [
      {
        "name": "supportNumber",
        "values": [
          {
            "value": "(910) 999-9999",
            "format": "small"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportNumber"
          }
        }
      },
      {
        "name": "support_url",
        "values": [
          {
            "value": "https://www.3rdparty.bank/support",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/es/support",
            "language": "es",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/fr/support",
            "language": "fr",
            "format": "small"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/text/textString/v1.3.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportUrl"
          }
        }
      }
    ]
  }
}

Text String Collection (v1.3.0)

Collection of text strings. The items in the collection are ordered in the _embedded.items array; the name is strings.

Properties

Name	Description
Text String Collection (v1.3.0)	object Collection of text strings. The items in the collection are ordered in the _embedded.items array; the name is strings.
_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 common/links.
_embedded	object Embedded objects.
» items	array: [textString] An array containing text string items. items: object
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_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.

---