API documentation
/organizations
Complete collection of organizations
Get a list of organizations
Create a new organization
get /organizations
Get a list of organizations
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- status: (string)
The organizations status
Example:
active - displayName: (string)
The preferred display name of the organization
Example:
Bank - country: (string)
The country of the main location of the organization
Example:
CA
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"organizations": [
{
"@id": "http://example.com/organization/100000",
"status": {
"@context": "http://example.com/status",
"@value": "active"
}
"name": "Bank of Scott",
"country": {
"@context": "http://example.com/status",
"@value": "canada"
}
"modified": "2020-02-11T12:34:56Z"
},{
"organizationId": "100042",
"status": "active",
"name": "Jonn-E Mon-E Mart",
"country": "CA",
"modified": "2019-11-13T14:50:34Z"
}
]
}
put /organizations
Create a new organization
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- displayName: required(string)
The preferred display name of the organization
Example:
My Organization
HTTP status code 200
Body
Media type: application/json
Type: organization
Example:
{
"organizationId": "100200",
"status": "active",
"name": "My Organization",
"modified": "2020-04-01T15:43:17Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Organization not found"}
/organizations/{organizationId}
Details about an organization
Get all the details for an organization
Update an organization
get /organizations/{organizationId}
Get all the details for an organization
URI Parameters
- organizationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"organizationId": "100042",
"status": "active",
"name": "Jonn-E Mon-E Mart",
"country": "CA",
"modified": "2019-11-13T14:50:34Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Organization not found"}
post /organizations/{organizationId}
Update an organization
URI Parameters
- organizationId: required(string)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- displayName: required(string)
The preferred display name of the organization
Example:
My Organization - location: required(location)
The main location of the orgainzation
Example:
{ "street": "123 Main St", "city": "Ottawa", "province": "Ontario", "country": "Canada", "postalCode": "K1K1K1" }
HTTP status code 200
Body
Media type: application/json
Type: organization
Example:
{
"organizationId": "100200",
"status": "active",
"name": "My Organization",
"mainLocation": {
"street": "123 Main St",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"postalCode": "K1K1K1"
}
"modified": "2020-04-01T15:43:17Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Organization not found"}
/organizations/{organizationId}/enable
Enable an organization
Enable an organization
get /organizations/{organizationId}/enable
Enable an organization
URI Parameters
- organizationId: required(string)
/organizations/{organizationId}/disable
Disable an organization
Disable an organizaiton
get /organizations/{organizationId}/disable
Disable an organizaiton
URI Parameters
- organizationId: required(string)
/locations
Complete collection of locations
Get a list of locations
Create a new location
get /locations
Get a list of locations
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- status: (string)
The locations status
Example:
active - locationReference: (string)
The organization reference to the location
Example:
Bank - country: (string)
The country of the main location of the organization
Example:
CA
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"locations": [
{
"street": "500 Bank Street",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"modified": "2020-02-11T12:34:56Z"
},{
"street": "234 Main Street",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"modified": "2019-11-13T14:50:34Z"
}
]
}
put /locations
Create a new location
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- organizationId: required(number)
The organization the location belongs to
Example:
12345 - locationName: required(string)
The display name of the location
Example:
Bank Street - locationReference: required(string)
The organizations internal reference for the location
Example:
OTTAWA-3939 - street: required(string)
Street address of the location
Example:
500 Bank Street - city: required(string)
City of the location
Example:
Ottawa - province: required(string)
Province of the location
Example:
Ontario - country: required(string)
Country of the location
Example:
Canada
HTTP status code 200
Body
Media type: application/json
Type: location
Example:
{
"street": "500 Bank Street",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"modified": "2020-02-11T12:34:56Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Location not found"}
/locations/{locationId}
Details about an location
Get all the details for an location
Update an location
get /locations/{locationId}
Get all the details for an location
URI Parameters
- locationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"street": "500 Bank Street",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"modified": "2020-02-11T12:34:56Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Location not found"}
post /locations/{locationId}
Update an location
URI Parameters
- locationId: required(string)
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- locationName: required(string)
The display name of the location
Example:
Bank Street - street: required(string)
Street address of the location
Example:
500 Bank Street - city: required(string)
City of the location
Example:
Ottawa - province: required(string)
Province of the location
Example:
Ontario - country: required(string)
Country of the location
Example:
Canada
HTTP status code 200
Body
Media type: application/json
Type: location
Example:
{
"street": "500 Bank Street",
"city": "Ottawa",
"province": "Ontario",
"country": "Canada",
"modified": "2020-02-11T12:34:56Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission Denied"}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Location not found"}
/locations/{locationId}/enable
Enable an location
Enable an location
get /locations/{locationId}/enable
Enable an location
URI Parameters
- locationId: required(string)
/locations/{locationId}/disable
Disable an location
Disable an organizaiton
get /locations/{locationId}/disable
Disable an organizaiton
URI Parameters
- locationId: required(string)