Organizations

May 2024 ยท 3 minute read

Media type: application/json

Type: json

Content:

{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Collection of address records", "type": "object", "properties": { "addresses": { "description": "The list of addresses in this collection", "type": "array", "id": "addresses", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "description": "An address record", "properties": { "id": { "description": "UUID", "$schema": "http://json-schema.org/draft-04/schema#", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "addressLine1": { "description": "The first line of this address", "type": "string" }, "addressLine2": { "description": "The second line of this address", "type": "string" }, "city": { "description": "The city for this address", "type": "string" }, "stateRegion": { "description": "The state or region for this address", "type": "string" }, "zipCode": { "description": "The zip code for this address", "type": "string" }, "country": { "description": "The country for this address", "type": "string" }, "isPrimary": { "description": "Used to set this address as primary for the contact", "type": "boolean" }, "categories": { "id": "categories", "description": "The list of categories for this organization address", "type": "array", "items": { "type": "string" } }, "language": { "description": "The language for this organization address", "type": "string" }, "metadata": { "type": "object", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "id": "metadata.schema", "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } }, "totalRecords": { "description": "The number of address records returned in this collection", "type": "integer" } }, "additionalProperties": false, "required": [ "addresses", "totalRecords" ] }

Example:

{ "addresses": [ { "id": "588b5c42-8634-4af7-bc9b-5e0116ed96b6", "addressLine1": "10 Estes Street", "addressLine2": "", "city": "Ipswich", "stateRegion": "MA", "zipCode": "01938", "country": "USA", "metadata": { "createdDate": "2019-06-19T00:00:00.000+0000", "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1" } } ], "totalRecords": 1 } 

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Media type: text/plain

Type: any

Example:

unable to list addresses -- malformed parameter 'query', syntax error at column 6

Media type: text/plain

Type: any

Example:

unable to list addresses -- unauthorized

Media type: application/json

Type: json

Content:

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "errors.schema", "description": "A set of errors", "type": "object", "properties": { "errors": { "description": "List of errors", "id": "errors", "type": "array", "items": { "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "id": "error.schema", "description": "An error", "properties": { "message": { "type": "string", "description": "Error message text" }, "type": { "type": "string", "description": "Error message type" }, "code": { "type": "string", "description": "Error message code" }, "parameters": { "description": "Error message parameters", "$schema": "http://json-schema.org/draft-04/schema#", "id": "parameters.schema", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } }, "required": [ "message" ] } }, "total_records": { "description": "Total number of errors", "type": "integer" } } }

Example:

{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ] } 

Internal server error, e.g. due to misconfiguration

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

ncG1vNJzZmirY2Ourq3ZqKWar6NjsLC5jp%2BmpaGfmbykv46ap6JnnaSxbrvRoJinoaqWwaq7zaxkrKyfp66osY6pZpqclKeytL%2BNoaumpA%3D%3D