- Partner Organizations v0.15.0
- Error Types
- Authentication
- Partner Organization
- API
-
Schemas
- abstractRequest
- abstractResource
- address
- addressType
- attributes
- createInvitation
- createOrganization
- cursorPagedCollection
- domainValidation
- emailType
- error
- errorResponse
- invitation
- invitee
- labelGroup
- labelGroups
- labelItem
- link
- links
- organization
- organizationAddress
- organizationEmailAddress
- organizationIdentification
- organizationIdentificationType
- organizationPhoneNumber
- organizationState
- organizationSubtype
- organizationType
- organizations
- phoneNumber
- phoneNumberType
- profileItemState
- root
- simpleAddress
- simpleLabel
- simpleOrganization
- summaryOrganization
- typedEmailAddress
Partner Organizations v0.15.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.
Client and partner organizations (businesses, financial institutions etc.) which register on the Apiture Developer portal for API keys.
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.
invalidPartnerDomain
Description: The current user's email address is associated with a restricted partner organization domain.
Remediation: Register using a company email address, not an email service.
malformedRequestBodyBadRequest
Description: The supplied request body was malformed.
Remediation: Check to make sure that your request body exists and that it does not contain syntax errors.
partnerOrganizationInUse
Description: The partner organization may be be deleted if there are client applications.
Remediation: First remove then delete all client applications belonging to this partner organization, then delete the partner organization.
removedPartnerOrganizationImmutable
Description: The state of a removed partner organization may not be changed.
Remediation: Delete the partner organization and create a new one.
wrongPartnerDomain
Description: The invitee's email address does not match this partner's domain.
Remediation: Invite only people on the same partner domain.
The attributes
object in the error may have the following properties:
Property | Type | Description |
---|---|---|
expectedDomain | string |
The expected partner domain |
actualDomain | string |
The actual, unmatched partner domain. |
Download OpenAPI Definition (YAML)
Base URLs:
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the
API-Key: {api-key}
request header.
- OAuth2 authentication (
accessToken
)- OAuth2 client access token authentication. The client authenticates against the server at
authorizationUrl
, passing the client's privateclientId
(and optionalclientSecret
) as part of this flow. The client obtains an access token from the server attokenUrl
. It then passes the received access token via theAuthorization: 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.developer.apiture.com/auth/oauth2/authorize
- Token URL = https://api.developer.apiture.com/auth/oauth2/token
- OAuth2 client access token authentication. The client authenticates against the server at
Scope | Scope Description |
---|---|
profiles/read |
Read access to partner related resources. |
profiles/write |
Write (update) access to partner related resources. |
admin/delete |
Administrator delete access to partner related resources. |
profiles/readPii |
Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the profiles/read scope in order to read such data, but is included in the profiles/full scope. |
profiles/full |
Full access to partner related resources. |
Partner Organization
Partner Organization
getOrganizations
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/partners/organizations \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/partners/organizations 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',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/organizations',
{
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',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/organizations',
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',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/partners/organizations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/partners/organizations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations");
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"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/partners/organizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of organizations
GET https://api.devbank.apiture.com/partners/organizations
Return a paginated filterable collection of organizations. The links in the response include pagination links. The result is limited to partner organizations that the caller has access to (usually, their own partner organization) based on their email address domain. (Admin users have access to all partner organizations.)
Parameters
Parameter | Description |
---|---|
start in: query | string Represents the first record of the page of results. This is supplied by the service when paginating items: the next link includes a ?start= query parameter which refers to beginning of the next page of items. |
limit in: query | integer(int32) The maximum number of organization representations to return in this page. format: int32 default: 100 |
filter in: query | string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions: • Property state using functions eq , ne , in • Property type using functions eq , ne , in • Property name using functions eq , ne , lt , le , gt , ge , startsWith , endsWith , contains , search • Property domain using functions eq . |
domain in: query | string Subset the result to match only partner organizations whose domain property matches this value. This is combined with the filter query, if any, via and implicit and . Note that for most users, the collection is already implicitly filtered to their organization. |
type in: query | string Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, ?type=corporation will match only items whose type is corporation ; ?type=llp|llc will match items whose type is llp or llc . This is combined with an implicit and with other filters if they are used. See filtering. |
state in: query | array[string] Subset the resources to only those whose state matches the query, such as ?state=active . The value may be a | separated list of states, such as ?state=pending|active to match all resources whose state is either pending or active . If ?filter= is also used, the two are combined with an implicit and() operation.pipe-delimited items: string » enum values: pending , active , inactive , removed |
name in: query | string Subset the organizations collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell will match only items whose name is Bartell; ?name=Bartell|kirsten will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations?start=g434ljkf430&limit=10"
},
"next": {
"href": "/organizations/organizations?start=p4900sk3df9&limit=10"
},
"collection": {
"href": "/organizations/organizations"
}
},
"start": "g434ljkf430",
"limit": 10,
"count": 10,
"name": "organizations",
"_embedded": {
"items": [
{
"_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
}
},
"name": "Apiture",
"label": "",
"type": "trust",
"state": "pending"
},
{
"_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
}
},
"name": "Apiture",
"label": "",
"type": "municipality",
"state": "pending"
},
{
"_id": "c161edaa-293f-4c01-a232-e9a14344b297",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
}
},
"name": "example corporation",
"label": "",
"type": "corporation",
"state": "pending"
},
{
"_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
}
},
"name": "example llc",
"label": "",
"type": "llc",
"state": "pending"
},
{
"_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
}
},
"name": "example partnership",
"label": "",
"type": "partnership",
"state": "pending"
},
{
"_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
}
},
"name": "example llp",
"label": "",
"type": "llp",
"state": "pending"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organizations |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createOrganization
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/partners/organizations \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/partners/organizations HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
const fetch = require('node-fetch');
const inputBody = '{
"_profile": "https://production.api.apiture.com/schemas/partners/createOrganization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09"
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/organizations',
{
method: 'POST',
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',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/organizations',
method: 'post',
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/partners/organizations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/partners/organizations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/partners/organizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new organization
POST https://api.devbank.apiture.com/partners/organizations
Create a new organization in the organizations collection.
Body parameter
{
"_profile": "https://production.api.apiture.com/schemas/partners/createOrganization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09"
}
Parameters
Parameter | Description |
---|---|
body | createOrganization (required) The data necessary to create a new organization. |
Example responses
201 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
201 | Created |
Created. | |
Schema: organization | |
Header | Location string uri |
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme ://host | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The caller does not have access to the requested resource or operation. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following | |
Schema: errorResponse |
getOrganization
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/partners/organizations/{organizationId} \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/partners/organizations/{organizationId} 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',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/organizations/{organizationId}',
{
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',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/organizations/{organizationId}',
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',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.devbank.apiture.com/partners/organizations/{organizationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-None-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.devbank.apiture.com/partners/organizations/{organizationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations/{organizationId}");
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"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/partners/organizations/{organizationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this organization
GET https://api.devbank.apiture.com/partners/organizations/{organizationId}
Return a HAL representation of this organization resource. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)
Parameters
Parameter | Description |
---|---|
organizationId in: path | string (required) The unique identifier of this organization. This is an opaque string. |
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/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The caller does not have access to the requested resource or operation. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified {organizationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
updateOrganization
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/partners/organizations/{organizationId} \
-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/partners/organizations/{organizationId} 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/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}';
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/partners/organizations/{organizationId}',
{
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/partners/organizations/{organizationId}',
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/partners/organizations/{organizationId}',
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/partners/organizations/{organizationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations/{organizationId}");
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/partners/organizations/{organizationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this organization
PUT https://api.devbank.apiture.com/partners/organizations/{organizationId}
Perform a complete replacement of this organization. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)
Body parameter
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Parameters
Parameter | Description |
---|---|
organizationId in: path | string (required) The unique identifier of this organization. This is an opaque string. |
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body | organization (required) A client organization (DevPortal partner). |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The caller does not have access to the requested resource or operation. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified {organizationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
patchOrganization
Code samples
# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/partners/organizations/{organizationId} \
-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}'
PATCH https://api.devbank.apiture.com/partners/organizations/{organizationId} 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/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}';
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/partners/organizations/{organizationId}',
{
method: 'PATCH',
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/partners/organizations/{organizationId}',
method: 'patch',
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.patch 'https://api.devbank.apiture.com/partners/organizations/{organizationId}',
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.patch('https://api.devbank.apiture.com/partners/organizations/{organizationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/partners/organizations/{organizationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this organization
PATCH https://api.devbank.apiture.com/partners/organizations/{organizationId}
Perform a partial update of this organization. Fields which are omitted are not updated. Nested _embedded
and _links
are ignored if included. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)
Body parameter
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Parameters
Parameter | Description |
---|---|
organizationId in: path | string (required) The unique identifier of this organization. This is an opaque string. |
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body | organization (required) A client organization (DevPortal partner). |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The caller does not have access to the requested resource or operation. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified {organizationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
deleteOrganization
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/partners/organizations/{organizationId} \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/partners/organizations/{organizationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/organizations/{organizationId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/organizations/{organizationId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/partners/organizations/{organizationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/partners/organizations/{organizationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []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/partners/organizations/{organizationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this organization resource
DELETE https://api.devbank.apiture.com/partners/organizations/{organizationId}
Delete this organization resource. Most callers do not have delete access. (Admin users have delete access to all partner organizations.)
Parameters
Parameter | Description |
---|---|
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
organizationId in: path | string (required) The unique identifier of this organization. This is an opaque string. |
Example responses
403 Response
{
"_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"_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": []
}
}
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The resource was deleted successfully. |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The caller does not have access to the requested resource or operation. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified {organizationId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. Cannot create a new partner organization: there is already an existing partner with this `domain'. | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
inviteMembers
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
const fetch = require('node-fetch');
const inputBody = '{
"_profile": "https://production.api.apiture.com/schemas/partners/createInvitation/v1.0.0/profile.json",
"_links": {},
"message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
"invitees": [
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
]
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations',
{
method: 'POST',
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',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations',
method: 'post',
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/hal+json"},
"Accept": []string{"application/hal+json"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Invite new members
POST https://api.devbank.apiture.com/partners/organizations/{organizationId}/memberInvitations
Invite new members to this partner organization. This operation sends the invitees an invitation email. This API does not track which people it has sent invitations to; it unconditionally emails each invitee even if they have been invited in the past or are already registered. When the recipients register on the developer portal with an email address with the same partner domain
, they are automatically added to the organization.
TODO: Provide API to remove members (i.e. if they leave the organization.)
Body parameter
{
"_profile": "https://production.api.apiture.com/schemas/partners/createInvitation/v1.0.0/profile.json",
"_links": {},
"message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
"invitees": [
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
]
}
Parameters
Parameter | Description |
---|---|
organizationId in: path | string (required) The unique identifier of this organization. This is an opaque string. |
body | createInvitation (required) The data necessary to invite one or more new members. |
Example responses
202 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/invitation/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
"invitees": [
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
]
}
Responses
Status | Description |
---|---|
202 | Accepted |
Accepted. | |
Schema: invitation |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. There are errors in the request. This error response may have one of the following | |
Schema: errorResponse |
activateOrganization
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/partners/activeOrganizations?organization=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/partners/activeOrganizations?organization=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/activeOrganizations?organization=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/activeOrganizations',
method: 'post',
data: '?organization=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/partners/activeOrganizations',
params: {
'organization' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/partners/activeOrganizations', params={
'organization': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/activeOrganizations?organization=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/partners/activeOrganizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Activate a partner organization.
POST https://api.devbank.apiture.com/partners/activeOrganizations
Activate a partner organization from an inactive state.
This operation is invoked from the apiture:activate
link on an organization resource when that partner resource is eligible to be activated.
This changes the state
to active
.
Parameters
Parameter | Description |
---|---|
organization in: query | string (required) A string which identifies existing organization whose state is being changed by POST ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI. |
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this partner organization resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to a partner organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
deactivateOrganization
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/partners/inactiveOrganizations?organization=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/partners/inactiveOrganizations?organization=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/inactiveOrganizations?organization=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/inactiveOrganizations',
method: 'post',
data: '?organization=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/partners/inactiveOrganizations',
params: {
'organization' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/partners/inactiveOrganizations', params={
'organization': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/inactiveOrganizations?organization=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/partners/inactiveOrganizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Deactivate a partner organization.
POST https://api.devbank.apiture.com/partners/inactiveOrganizations
Deactivate a partner organization from an active state.
This operation is invoked from the apiture:deactivate
link on an organization resource when that partner organization is eligible to be deactivated.
This changes the state
to inactive
.
Parameters
Parameter | Description |
---|---|
organization in: query | string (required) A string which identifies existing organization whose state is being changed by POST ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI. |
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this partner organization resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to a partner organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
removeOrganization
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/partners/removedOrganizations?organization=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/partners/removedOrganizations?organization=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/partners/removedOrganizations?organization=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/removedOrganizations',
method: 'post',
data: '?organization=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/hal+json',
'If-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/partners/removedOrganizations',
params: {
'organization' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/partners/removedOrganizations', params={
'organization': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/removedOrganizations?organization=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/hal+json"},
"If-Match": []string{"string"},
"API-Key": []string{"API_KEY"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/partners/removedOrganizations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Remove a partner organization.
POST https://api.devbank.apiture.com/partners/removedOrganizations
Remove a partner organization by setting its state to removed
.
This operation is invoked from the apiture:remove
link on a organization resource when that resource is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization).
This changes the state
to removed
.
Parameters
Parameter | Description |
---|---|
organization in: query | string (required) A string which identifies existing organization whose state is being changed by POST ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI. |
If-Match in: header | string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: organization | |
Header | ETag string |
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this partner organization resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to a partner organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim. | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
validatePartnerDomain
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/partners/domainValidations?domain=string \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/partners/domainValidations?domain=string 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/partners/domainValidations?domain=string',
{
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/partners/domainValidations',
method: 'get',
data: '?domain=string',
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/partners/domainValidations',
params: {
'domain' => 'string'
}, 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/partners/domainValidations', params={
'domain': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/domainValidations?domain=string");
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/partners/domainValidations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Validate a partner domain name
GET https://api.devbank.apiture.com/partners/domainValidations
Check if a partner domain is valid. Some domains are not valid for use in the developer portal, such as those assocated with generic email services (gmail.com
, outlook.com
, yahoo.com
, aol.com
, and so on). The domain is passed as a query parameter. The 200 response is a JSON object, and the _error
will be populated if the domain is not valid.
Parameters
Parameter | Description |
---|---|
domain in: query | string (required) A candidate partner domain, such as example.com or apiture.com . This is typically taked from the user's email address, following the @ character. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
A HAL response, with an optional This error response may have one of the following | |
Schema: domainValidation |
API
Endpoints which describe this API.
getApi
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/partners/ \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/partners/ 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/partners/',
{
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/partners/',
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/partners/',
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/partners/', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/");
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/partners/", 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/partners/
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/apiName/resourceName/resourceId"
}
},
"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/partners/apiDoc \
-H 'Accept: application/json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/partners/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/partners/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/partners/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/partners/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/partners/apiDoc', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/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/partners/apiDoc", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return API definition document
GET https://api.devbank.apiture.com/partners/apiDoc
Return the OpenAPI document that describes this API.
Example responses
200 Response
{}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: Inline |
Response Schema
getLabels
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/partners/labels \
-H 'Accept: application/hal+json' \
-H 'Accept-Language: string' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/partners/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'Accept-Language':'string',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/partners/labels',
{
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',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/partners/labels',
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',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/partners/labels',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'Accept-Language': 'string',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/partners/labels', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/partners/labels");
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"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/partners/labels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Localized Labels
GET https://api.devbank.apiture.com/partners/labels
Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API.
The labels in the response may not all match the requested language; some may be in the default language (en-us
).
Parameters
Parameter | Description |
---|---|
Accept-Language in: header | string The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231. |
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"groups": {
"fristGroup": {
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"key1": {
"label": "Label for Key 1",
"code": "1",
"variants": {
"es": {
"label": "(Spanish label for Key 1)"
},
"fr": {
"label": "(French label for Key 1)"
}
}
},
"key2": {
"label": "Label for Key 2",
"code": "2",
"variants": {
"es": {
"label": "(Spanish label for Key 2)"
},
"fr": {
"label": "(French label for Key 2)"
}
}
},
"key3": {
"label": "Label for Key 3",
"code": "3",
"variants": {
"es": {
"label": "(Spanish label for Key 3)"
},
"fr": {
"label": "(French label for Key 3)"
}
}
},
"other": {
"label": "Other",
"variants": {
"es": {
"label": "(Spanish label for Other)"
},
"fr": {
"label": "(French label for Other)"
}
},
"code": "254"
}
},
"secondGroup": {
"unknown": {
"label": "Unknown",
"code": "?",
"hidden": true
},
"optionA": {
"label": "Option A",
"code": "A"
},
"optionB": {
"label": "Option B",
"code": "B"
},
"optionC": {
"label": "Option C",
"code": "C"
},
"other": {
"label": "Other",
"code": "_"
}
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: labelGroups |
Schemas
abstractRequest
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
"_links": {}
}
Abstract Request (v2.0.0)
An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error
defined in abstractResource
.
This schema was resolved from common/abstractRequest
.
Properties
Name | Description |
---|---|
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 |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | 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/apiName/resourceName/resourceId"
}
}
}
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) | 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 |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
address
{
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "ha5",
"type": "home"
}
Address (v1.0.0)
A postal address with the address type and an identifier.
This schema was resolved from contacts/address
.
Properties
Name | Description |
---|---|
Address (v1.0.0) | A postal address with the address type and an identifier. This schema was resolved from |
addressLine1 | The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128 |
addressLine2 | The optional second street address line of the address. maxLength: 128 |
city | The name of the city or municipality. minLength: 2 maxLength: 128 |
regionCode | The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
postalCode | The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: "^[0-9]{5}(?:-[0-9]{4})?$" |
countryCode | The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
type | (required) The type of this address. enum values: unknown , home , prior , work , school , mailing , vacation , shipping , billing , headquarters , commercial , site , property , other , notApplicable |
label | A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32 |
otherType | The actual address type if type is other .minLength: 4 maxLength: 32 |
_id | An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" |
addressType
"unknown"
Address Type (v1.0.0)
The type of a postal address.
Warning: The enum
list will be removed in a future release.
The allowed values for this property are defined at runtime in the label group named addressType
in the response from the getLabels
operation.
This schema was resolved from contacts/addressType
.
type:
string
enum values: unknown
, home
, prior
, work
, school
, mailing
, vacation
, shipping
, billing
, headquarters
, commercial
, site
, property
, other
, notApplicable
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) | An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from |
createInvitation
{
"_profile": "https://production.api.apiture.com/schemas/partners/createInvitation/v1.0.0/profile.json",
"_links": {},
"message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
"invitees": [
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
]
}
Create Invitation (v1.0.0)
Representation used to create an invitation to join a partner organization.
Properties
Name | Description |
---|---|
Create Invitation (v1.0.0) | Representation used to create an invitation to join a partner organization. |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
message | (required) An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. format: markdown minLength: 16 maxLength: 512 |
invitees | array: (required) The list of invitees. minItems: 1 maxItems: 16 items: object |
createOrganization
{
"_profile": "https://production.api.apiture.com/schemas/partners/createOrganization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09"
}
Create Partner Organization (v1.0.0)
Representation used to create a new organization.
Properties
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create Partner Organization (v1.0.0) | Representation used to create a new organization. | ||||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | ||||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | ||||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | ||||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | ||||||||||
name | (required) The organization's official full name | ||||||||||
label | The organization's common name. | ||||||||||
type | Indicates what type of organization this resource represents. The enumeration values are described by the | ||||||||||
subtype | A refinement of the type . The enumeration values are described by the | ||||||||||
identification | array: A collection of official identifying information associated with the organization. This currently only supports government tax ID. items: object | ||||||||||
addresses | array: An array containing address items. items: object | ||||||||||
phones | array: An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. items: object | ||||||||||
emailAddresses | array: An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. items: object | ||||||||||
preferredEmailAddressId | The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredPhoneId | The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredMailingAddressId | The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
establishedOn | The date the organization was established. format: date | ||||||||||
| The date the organization was established. Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.format: date deprecated: true | ||||||||||
state | The state of this partner organization.
These enumeration values are further described by the label group named | ||||||||||
homeUrl | The organization's home page. format: uri maxLength: 512 | ||||||||||
attributes | An optional map of name/value pairs which provide additional metadata about the organization. |
cursorPagedCollection
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
}
}
Cursor Paged Collection (v2.1.0)
A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start
. The _links
in the collection may contain pagination links:
- the
next
link returns the next page of items. If there is nonext
link, the collection has been exhausted. - the
first
link returns to the beginning of the filtered/sorted collection. - the
collection
link returns to the beginning of the default collection with no explicit filter or sort criteria.
Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records.
This schema was resolved from common/cursorPagedCollection
.
Properties
Name | Description |
---|---|
Cursor Paged Collection (v2.1.0) | A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start . The _links in the collection may contain pagination links:
Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records. This schema was resolved from |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
start | An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links . |
limit | The maximum number of items per page. |
name | A name for the items in collection. |
domainValidation
{
"_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
}
}
Domain Validation (v1.0.0)
The response from validating a partner domain.
Properties
Name | Description |
---|---|
Domain Validation (v1.0.0) | The response from validating a partner domain. |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
valid | true if the domain is valid, false if not. If false , consult the _error object. |
emailType
"unknown"
Email Type (v1.0.0)
The kind of email address.
Warning: The enum
list will be removed in a future release.
The allowed values for this property are defined at runtime in the label group named emailType
in the response from the getLabels
operation.
This schema was resolved from contacts/emailType
.
type:
string
enum values: unknown
, personal
, work
, school
, other
, notApplicable
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) | Describes an error in an API request or in a service called via the API. This schema was resolved from |
message | (required) A localized message string describing the error condition. |
_id | 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 | The HTTP status code associate with this error. minimum: 100 maximum: 599 |
type | 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 | An RFC 3339 UTC time stamp indicating when the error occurred. format: date-time |
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 | An optional localized string which provides hints for how the user or client can resolve the error. |
errors | array: 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/apiName/resourceName/resourceId"
}
},
"_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) | 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 |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
invitation
{
"_profile": "https://production.api.apiture.com/schemas/partners/invitation/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
"invitees": [
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
]
}
Member Invitation (v1.0.0)
Partner Organization member invitation.
Properties
Name | Description |
---|---|
Member Invitation (v1.0.0) | Partner Organization member invitation. |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
message | (required) An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. format: markdown minLength: 16 maxLength: 512 |
invitees | array: (required) The list of invitees. minItems: 1 maxItems: 16 items: object |
invitee
{
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john.smith@example.com"
}
Invitee (v1.0.0)
Representation of new partner organization member invitee.
Properties
Name | Description |
---|---|
Invitee (v1.0.0) | Representation of new partner organization member invitee. |
firstName | (required) The first name of the invitee. maxLength: 64 |
lastName | (required) The last name of the invitee. maxLength: 64 |
emailAddress | (required) The email address of the invitee. maxLength: 128 |
labelGroup
{
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"under1Million": {
"label": "Under $1M",
"code": "1",
"range": "[0,1000000.00)",
"variants": {
"fr": {
"label": "Moins de $1M"
}
}
},
"from1to10Million": {
"label": "$1M to $10M",
"code": "2",
"range": "[1000000.00,10000000.00)",
"variants": {
"fr": {
"label": "$1M \\u00e0 $10M"
}
}
},
"from10to100Million": {
"label": "$10M to $100M",
"code": "3",
"range": "[10000000.00,100000000.00)",
"variants": {
"fr": [
"label $10M \\u00e0 $100M"
]
}
},
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]",
"variants": {
"fr": {
"label": "Plus de $10M"
}
}
},
"other": {
"label": "Other",
"code": 254
}
}
Label Group (v1.0.0)
A map that defines labels for the items in a group. This is a map from each item name โ a labelItem
object. For example, consider a JSON response that includes a property named revenueEstimate
; the values for revenueEstimate
must be one of the items in the group named estimatedAnnualRevenue
, with options ranging under1Million
, to over100Million
. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}
, and the item with the name from10to100Million
defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00)
.
This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:
- Unknown
- Under $1M
- $1M to $10M
- $10M to $100M
- $100M or more
Note that the other
item is hidden from the selection list, as that item is marked as hidden
. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate
to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }
.
This schema was resolved from common/labelGroup
.
Properties
Name | Description |
---|---|
Label Group (v1.0.0) | A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate ; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue , with options ranging under1Million , to over100Million . The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...} , and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00) . This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:
Note that the This schema was resolved from |
Label Item (v1.0.0) | An item in a labelGroup , with a set of variants which contains different localized labels for the item. Each (simpleLabel ) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from |
labelGroups
{
"_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"groups": {
"fristGroup": {
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"key1": {
"label": "Label for Key 1",
"code": "1",
"variants": {
"es": {
"label": "(Spanish label for Key 1)"
},
"fr": {
"label": "(French label for Key 1)"
}
}
},
"key2": {
"label": "Label for Key 2",
"code": "2",
"variants": {
"es": {
"label": "(Spanish label for Key 2)"
},
"fr": {
"label": "(French label for Key 2)"
}
}
},
"key3": {
"label": "Label for Key 3",
"code": "3",
"variants": {
"es": {
"label": "(Spanish label for Key 3)"
},
"fr": {
"label": "(French label for Key 3)"
}
}
},
"other": {
"label": "Other",
"variants": {
"es": {
"label": "(Spanish label for Other)"
},
"fr": {
"label": "(French label for Other)"
}
},
"code": "254"
}
},
"secondGroup": {
"unknown": {
"label": "Unknown",
"code": "?",
"hidden": true
},
"optionA": {
"label": "Option A",
"code": "A"
},
"optionB": {
"label": "Option B",
"code": "B"
},
"optionC": {
"label": "Option C",
"code": "C"
},
"other": {
"label": "Other",
"code": "_"
}
}
}
}
Label Groups (v1.1.0)
A set of named groups of labels, each of which contains multiple item labels.
The abbreviated example shows two groups, one named structure
and one named estimatedAnnualRevenue
. The first has items with names such as corporation
, llc
and soleProprietorship
, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million
has the label
"$1M to $10M" and the range [1000000.00,10000000.00)
.
This schema was resolved from common/labelGroups
.
Properties
Name | Description |
---|---|
Label Groups (v1.1.0) | A set of named groups of labels, each of which contains multiple item labels. The abbreviated example shows two groups, one named This schema was resolved from |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
groups | Groups of localized labels. This maps group names → a group of labels within that group. |
ยป Label Group (v1.0.0) | A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate ; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue , with options ranging under1Million , to over100Million . The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...} , and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00) . This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:
Note that the This schema was resolved from |
labelItem
{
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]",
"variants": {
"fr": {
"label": "Plus de $10M"
}
}
}
}
Label Item (v1.0.0)
An item in a labelGroup
, with a set of variants
which contains different localized labels for the item. Each (simpleLabel
) variant defines the presentation text label and optional description for a language. Items may also have a lookup code
to map to external syststems, a numeric range, and a hidden
boolean to indicate the item is normally hidden in the UI.
This schema was resolved from common/labelItem
.
Properties
Name | Description |
---|---|
Label Item (v1.0.0) | An item in a labelGroup , with a set of variants which contains different localized labels for the item. Each (simpleLabel ) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from |
label | (required) A label or title which may be used as labels or other UI controls which present a value. |
description | A more detailed localized description of a localizable label. |
variants | The language-specific variants of this label. The keys in this object are RFC 7231 language codes. |
ยป Simple Label (v1.0.0) | A text label and optional description. This schema was resolved from |
code | If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value. minLength: 1 |
hidden | If true , this item is normally hidden from the User Interface. |
range | The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max] , (exclusiveMin,max] , [min,exclusiveMax) , or (exclusiveMin,exclusiveMax) . For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps.pattern: "^[\\[\\(](-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?[\\]\\)]$" |
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) | 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 |
href | (required) The URI or URI template for the resource/operation this link refers to. format: uri |
type | The media type for the resource. |
templated | If true, the link's href is a URI template. |
title | An optional human-readable localized title for the link. |
deprecation | 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 | 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) | 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 |
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 |
organization
{
"_profile": "https://production.api.apiture.com/schemas/partners/organization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_embedded": {}
}
Partner Organization (v1.0.0)
Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for a partner organization. a partner organization may have the following links in the _links
object:
apiture:activate
- Activate a new, pending organization.apiture:deactivate
- Deactivate a partner organization (if it is active).apiture:remove
- Remove an inactive organization.
Properties
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Partner Organization (v1.0.0) | Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for a partner organization. a partner organization may have the following links in the
| ||||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | ||||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | ||||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | ||||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | ||||||||||
name | The organization's official full name | ||||||||||
label | The organization's common name. | ||||||||||
type | Indicates what type of organization this resource represents. The enumeration values are described by the | ||||||||||
subtype | A refinement of the type . The enumeration values are described by the | ||||||||||
identification | array: A collection of official identifying information associated with the organization. This currently only supports government tax ID. items: object | ||||||||||
addresses | array: An array containing address items. items: object | ||||||||||
phones | array: An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. items: object | ||||||||||
emailAddresses | array: An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. items: object | ||||||||||
preferredEmailAddressId | The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredPhoneId | The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredMailingAddressId | The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
establishedOn | The date the organization was established. format: date | ||||||||||
| The date the organization was established. Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.format: date deprecated: true | ||||||||||
state | The state of this partner organization.
These enumeration values are further described by the label group named | ||||||||||
homeUrl | The organization's home page. format: uri maxLength: 512 | ||||||||||
_id | The unique identifier for this organization resource. This is an immutable opaque string. | ||||||||||
domain | This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. read-only | ||||||||||
attributes | An optional map of name/value pairs which provide additional metadata about the organization. | ||||||||||
createdAt | The date-time when the organization was created. format: date-time | ||||||||||
updatedAt | The date-time when the organization was updated format: date-time |
organizationAddress
{
"_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ha1"
}
},
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "ha1",
"type": "home",
"state": "approved"
}
Organization Address (v1.1.0)
Representation of an organization's address resource.
Links
Response and request bodies using this organizationAddress
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this address resource | DELETE |
apiture:setAsPreferred | Set Preferred mailing Address | PUT |
This schema was resolved from organizations/organizationAddress
.
Properties
Name | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Organization Address (v1.1.0) | Representation of an organization's address resource. LinksResponse and request bodies using this
This schema was resolved from | |||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | |||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | |||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | |||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | |||||||||
addressLine1 | The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128 | |||||||||
addressLine2 | The optional second street address line of the address. maxLength: 128 | |||||||||
city | The name of the city or municipality. minLength: 2 maxLength: 128 | |||||||||
regionCode | The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" | |||||||||
postalCode | The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: "^[0-9]{5}(?:-[0-9]{4})?$" | |||||||||
countryCode | The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" | |||||||||
type | (required) The type of this address. enum values: unknown , home , prior , work , school , mailing , vacation , shipping , billing , headquarters , commercial , site , property , other , notApplicable | |||||||||
label | A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32 | |||||||||
otherType | The actual address type if type is other .minLength: 4 maxLength: 32 | |||||||||
_id | An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" | |||||||||
state | The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.enum values: pending , approved |
organizationEmailAddress
{
"_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
},
"delete": {
"href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
}
},
"_id": "pe1",
"type": "personal",
"number": "+19105550155",
"state": "approved"
}
Email Address (v1.1.0)
Representation of email address resources. An email address is immutable, although organizations can add new email addresses.
Links
Response and request bodies using this organizationEmailAddress
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this email address resource | DELETE |
apiture:setAsPreferred | Set Preferred Email Address | PUT |
This schema was resolved from organizations/organizationEmailAddress
.
Properties
Name | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Email Address (v1.1.0) | Representation of email address resources. An email address is immutable, although organizations can add new email addresses. LinksResponse and request bodies using this
This schema was resolved from | |||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | |||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | |||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | |||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | |||||||||
value | The email address, such as JohnBankCustomer@example.com format: email minLength: 8 maxLength: 120 | |||||||||
type | The kind of email address. enum values: unknown , personal , work , school , other , notApplicable | |||||||||
_id | An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" | |||||||||
state | The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.enum values: pending , approved |
organizationIdentification
{
"value": "string",
"type": "taxId",
"expiresOn": "2019-08-24",
"expiration": "2019-08-24"
}
Organization Identification (v1.1.0)
The type and value of the organizations unique identification numbers.
This schema was resolved from organizations/organizationIdentification
.
Properties
Name | Description |
---|---|
Organization Identification (v1.1.0) | The type and value of the organizations unique identification numbers. This schema was resolved from |
value | (required) The value of this form of identification (the tax ID as a string, for example) |
type | (required) The type of this form of identification. taxId is the only supported type at this time.enum values: taxId , dunsNumber |
expiresOn | The date when this form of identification expires. format: date |
| The date when this form of identification expires. Warning: The property expiration was deprecated on version v1.1.0 of the schema. Use expiresOn instead. expiration will be removed on version v2.0.0 of the schema.format: date deprecated: true |
organizationIdentificationType
"taxId"
Organization Identification Type (v1.0.0)
The type of the form of an organization's identification. taxId
is the only supported type at this time.
organizationIdentificationType
strings may have one of the following enumerated values:
Value | Description |
---|---|
taxId | Tax Identification Number: The company's federal Tax Identification Number. This is also known as the Employer Identification Number or EIN in the US. It may be the owner's SSN for a sole proprietorship. |
dunsNumber | Dun & Bradstreet D-U-N-S Number: Dun & Bradstreet D-U-N-S Number, a unique nine-digit identifier for businesses. |
These enumeration values are further described by the label group named organizationIdentificationType
in the response from the getLabels
operation.
This schema was resolved from organizations/organizationIdentificationType
.
type:
string
enum values: taxId
, dunsNumber
organizationPhoneNumber
{
"_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
},
"_id": "hp1",
"type": "home",
"number": "+19105550155",
"state": "approved"
}
Phone Number (v1.1.0)
Representation of phone number resources.
Links
Response and request bodies using this organizationPhoneNumber
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this phone number resource | DELETE |
apiture:setAsPreferred | Set Preferred Phone Number | PUT |
This schema was resolved from organizations/organizationPhoneNumber
.
Properties
Name | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Phone Number (v1.1.0) | Representation of phone number resources. LinksResponse and request bodies using this
This schema was resolved from | |||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | |||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | |||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | |||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | |||||||||
type | (required) The type or role of this phone number. enum values: unknown , home , work , mobile , fax , other | |||||||||
number | (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1 . Phone numbers are returned in responses in E.164 format with a leading + , country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information.minLength: 8 maxLength: 20 | |||||||||
label | A text label, suitable for presentation to the end user. This is also used if type is other .maxLength: 32 | |||||||||
_id | An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" | |||||||||
state | The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.enum values: pending , approved |
organizationState
"pending"
Partner Organization State (v1.0.0)
The state of this partner organization.
organizationState
strings may have one of the following enumerated values:
Value | Description |
---|---|
pending | Pending: The organization resource has been created but is not yet active; it is a draft and may be deleted. |
inactive | Inactive: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee. |
active | Active: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee. |
removed | Removed: The inactive organization resource is has been marked as removed. |
These enumeration values are further described by the label group named organizationState
in the response from the getLabels
operation.
type:
string
enum values: pending
, inactive
, active
, removed
organizationSubtype
"string"
Organization Subtype (v1.0.0)
A refinement of the organization type.
The allowed values for this property are defined at runtime in the label group named organizationSubtype
in the response from the getLabels
operation.
This schema was resolved from organizations/organizationSubtype
.
type:
string
organizationType
"string"
Organization Type (v1.0.0)
The primary organization type.
The allowed values for this property are defined at runtime in the label group named organizationType
in the response from the getLabels
operation.
This schema was resolved from organizations/organizationType
.
type:
string
organizations
{
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations?start=g434ljkf430&limit=10"
},
"next": {
"href": "/organizations/organizations?start=p4900sk3df9&limit=10"
},
"collection": {
"href": "/organizations/organizations"
}
},
"start": "g434ljkf430",
"limit": 10,
"count": 10,
"name": "organizations",
"_embedded": {
"items": [
{
"_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
}
},
"name": "Apiture",
"label": "",
"type": "trust",
"state": "pending"
},
{
"_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
}
},
"name": "Apiture",
"label": "",
"type": "municipality",
"state": "pending"
},
{
"_id": "c161edaa-293f-4c01-a232-e9a14344b297",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
}
},
"name": "Apiture",
"label": "",
"type": "nonprofit",
"state": "pending"
},
{
"_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
}
},
"name": "example corporation",
"label": "",
"type": "corporation",
"state": "pending"
},
{
"_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
}
},
"name": "example llc",
"label": "",
"type": "llc",
"state": "pending"
},
{
"_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
}
},
"name": "example partnership",
"label": "",
"type": "partnership",
"state": "pending"
},
{
"_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
"_profile": "https://production.api.apiture.com/schemas/partners/organizations/v1.0.0/profile.json",
"_links": {
"self": {
"href": "https://production.api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
},
"apiture:activate": {
"href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
}
},
"name": "example llp",
"label": "",
"type": "llp",
"state": "pending"
}
]
}
}
Partner Organization Collection (v1.0.0)
Collection of organizations. The items in the collection are ordered in the _embedded.items
array; the name
is organizations
. The top-level _links
object may contain pagination links (self
, next
, prev
, first
, last
, collection
).
Properties
Name | Description |
---|---|
Partner Organization Collection (v1.0.0) | Collection of organizations. The items in the collection are ordered in the _embedded.items array; the name is organizations . The top-level _links object may contain pagination links (self , next , prev , first , last , collection ). |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | Embedded objects. |
ยป items | array: An array containing a page of organization items. items: object |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
start | An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links . |
limit | The maximum number of items per page. |
name | A name for the items in collection. |
phoneNumber
{
"_id": "hp1",
"type": "home",
"number": "+19105550155"
}
Phone Number (v1.0.1)
A phone number and its role.
This schema was resolved from contacts/phoneNumber
.
Properties
Name | Description |
---|---|
Phone Number (v1.0.1) | A phone number and its role. This schema was resolved from |
type | (required) The type or role of this phone number. enum values: unknown , home , work , mobile , fax , other |
number | (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1 . Phone numbers are returned in responses in E.164 format with a leading + , country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information.minLength: 8 maxLength: 20 |
label | A text label, suitable for presentation to the end user. This is also used if type is other .maxLength: 32 |
_id | An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" |
phoneNumberType
"unknown"
Phone Number Type (v1.0.0)
The type or role of this phone number.
Warning: The enum
list will be removed in a future release.
The allowed values for this property are defined at runtime in the label group named phoneNumberType
in the response from the getLabels
operation.
This schema was resolved from contacts/phoneNumberType
.
type:
string
enum values: unknown
, home
, work
, mobile
, fax
, other
profileItemState
"approved"
Organization Profile Item State (v1.0.0)
The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state pending
, which means approval by the financial institution is pending. After they have been verified, the state becomes approved
. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). pending
items may not be assigned as the preferred item.
profileItemState
strings may have one of the following enumerated values:
Value | Description |
---|---|
pending | Pending: A profile item that the financial institution has not yet approved. |
approved | Approved: A profile item that the financial institution has approved. |
These enumeration values are further described by the label group named profileItemState
in the response from the getLabels
operation.
This schema was resolved from organizations/profileItemState
.
type:
string
enum values: pending
, approved
root
{
"_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
"_links": {
"self": {
"href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
}
},
"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) | A HAL response, with hypermedia _links for the top-level resources and operations in API. This schema was resolved from |
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from |
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. |
_profile | The URI of a resource profile which describes the representation. read-only format: uri |
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only |
_id | This API's unique ID. read-only |
name | This API's name. |
apiVersion | This API's version. |
simpleAddress
{
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
Simple Address (v1.0.0)
A postal address.
This schema was resolved from contacts/simpleAddress
.
Properties
Name | Description |
---|---|
Simple Address (v1.0.0) | A postal address. This schema was resolved from |
addressLine1 | The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128 |
addressLine2 | The optional second street address line of the address. maxLength: 128 |
city | The name of the city or municipality. minLength: 2 maxLength: 128 |
regionCode | The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
postalCode | The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: "^[0-9]{5}(?:-[0-9]{4})?$" |
countryCode | The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$" |
simpleLabel
{
"label": "Board of Directors",
"description": "string"
}
Simple Label (v1.0.0)
A text label and optional description.
This schema was resolved from common/simpleLabel
.
Properties
Name | Description |
---|---|
Simple Label (v1.0.0) | A text label and optional description. This schema was resolved from |
label | (required) A label or title which may be used as labels or other UI controls which present a value. |
description | A more detailed localized description of a localizable label. |
simpleOrganization
{
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "+19105550155"
},
{
"type": "mobile",
"number": "+19105550154"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"establishedOn": "2009-07-09",
"_profile": "https://production.api.apiture.com/schemas/organizations/simpleOrganization/v1.2.0/profile.json"
}
Simple Organization (v1.2.0)
The simplest form of an organization.
This schema was resolved from organizations/simpleOrganization
.
Properties
Name | Description |
---|---|
Simple Organization (v1.2.0) | The simplest form of an organization. This schema was resolved from |
name | The organization's official full name |
label | The organization's common name. |
type | Indicates what type of organization this resource represents. The enumeration values are described by the |
subtype | A refinement of the type . The enumeration values are described by the |
identification | array: A collection of official identifying information associated with the organization. This currently only supports government tax ID. items: object |
addresses | array: An array containing address items. items: object |
phones | array: An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. items: object |
emailAddresses | array: An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. items: object |
preferredEmailAddressId | The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.read-only minLength: 1 maxLength: 4 |
preferredPhoneId | The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.read-only minLength: 1 maxLength: 4 |
preferredMailingAddressId | The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.read-only minLength: 1 maxLength: 4 |
establishedOn | The date the organization was established. format: date |
| The date the organization was established. Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.format: date deprecated: true |
summaryOrganization
{
"_profile": "https://production.api.apiture.com/schemas/partners/summaryOrganization/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"emailAddresses": [
{
"type": "work",
"value": "smitties-detailing@example.com",
"_id": "we0"
}
],
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "mp0"
}
],
"addresses": [
{
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"_id": "wa0"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_id": "wa0"
}
],
"establishedOn": "2009-07-09",
"state": "active",
"establishedDate": "2009-07-09",
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
}
Partner Organization Summary (v1.0.0)
Summary representation of a partner organization resource in organizations collections. This representation normally does not contain any _embedded
objects. If needed, call the GET
operation on the item's self
link to get _embedded
objects.
Properties
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Partner Organization Summary (v1.0.0) | Summary representation of a partner organization resource in organizations collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. | ||||||||||
_links | An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from | ||||||||||
_embedded | An optional map of nested resources, mapping each nested resource name to a nested resource representation. | ||||||||||
_profile | The URI of a resource profile which describes the representation. read-only format: uri | ||||||||||
_error | An object which describes an error. This value is omitted if the operation succeeded without error. read-only | ||||||||||
name | The organization's official full name | ||||||||||
label | The organization's common name. | ||||||||||
type | Indicates what type of organization this resource represents. The enumeration values are described by the | ||||||||||
subtype | A refinement of the type . The enumeration values are described by the | ||||||||||
identification | array: A collection of official identifying information associated with the organization. This currently only supports government tax ID. items: object | ||||||||||
addresses | array: An array containing address items. items: object | ||||||||||
phones | array: An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. items: object | ||||||||||
emailAddresses | array: An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. items: object | ||||||||||
preferredEmailAddressId | The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredPhoneId | The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.read-only minLength: 1 maxLength: 4 | ||||||||||
preferredMailingAddressId | The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.read-only minLength: 1 maxLength: 4 | ||||||||||
establishedOn | The date the organization was established. format: date | ||||||||||
| The date the organization was established. Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.format: date deprecated: true | ||||||||||
state | The state of this partner organization.
These enumeration values are further described by the label group named | ||||||||||
homeUrl | The organization's home page. format: uri maxLength: 512 | ||||||||||
_id | The unique identifier for this organization resource. This is an immutable opaque string. | ||||||||||
domain | This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. read-only |
typedEmailAddress
{
"value": "JohnBankCustomer@example.com",
"type": "unknown",
"_id": "ha3"
}
Email Address (v1.0.0)
An email address and the email address type.
This schema was resolved from contacts/typedEmailAddress
.
Properties
Name | Description |
---|---|
Email Address (v1.0.0) | An email address and the email address type. This schema was resolved from |
value | The email address, such as JohnBankCustomer@example.com format: email minLength: 8 maxLength: 120 |
type | The kind of email address. enum values: unknown , personal , work , school , other , notApplicable |
_id | An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$" |
@apiture/api-doc
3.2.4 on Mon Oct 28 2024 14:41:12 GMT+0000 (Coordinated Universal Time).