Organizations for Account

Overview

The organizations API returns a list of organizations for the specified account ID from the Expere EZ Config Default Data application. The list includes all organizations that exist for any content source aliases and line of business combination to which the account has access.

Request

Table 1. Method
Method URL Description
GET https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/organizations?alias={alias}&lineOfBusiness={lineOfBusiness} Used to pass in the user's account ID ("accountId") to retrieve a list of organizations.
The following request parameter combinations may be used:
  • accountId
  • accountId and alias
  • accountId, alias, and lineOfBusiness
Table 2. Parameters
Name Type Constraints Description
accountID integer required The "accountID" parameter is used to retrieve a list of organizations associated with the user's account.
alias string (query) optional The "alias" parameter is the content source alias and can be used in combination with the accountId parameter to retrieve a list of organizations for the specified values.
lineOfBusiness string (query) optional The "lineOfBusiness" parameter can be used in combination with the accountId and alias parameters to retrieve a list of organizations for the specified values.
Note: Use of the lineOfBusiness parameter without the alias parameter is not supported and will be ignored.

Response

The organizations response returns the list of organizations through the parameters supplied in the request. Note that deleted organizations are not included in the returned results.

Response Message: the response message displays an HTTP Status Code of either 200, 401, 404, or 500 with the respective Reason.

HTTP Status Code Reason Response Model Headers
200 Success

Response Body: provides the organizationId, organizationName, alias and lineOfBusiness parameters within the response. 

[
  {
    "organizationId": 2,
    "organizationName": "West Branch Organization",
    "alias": "expere://CommercialR1\\.(.*)",
    "lineOfBusiness": "Commmercial"
  },
  {
    "organizationId": 5,
    "organizationName": East Branch Organization",
    "alias": "expere://CommercialR1\\.(.*)",
    "lineOfBusiness": "Commmercial"
  },
]

Response Code: provides the user with the appropriate HTTP status code based on the request:

200

Response Headers: the response header provides 

  cache-control: no-cache
  content-type: application/json; charset=utf-8
  date: Fri, 02 Nov 2018 13:50:02 GMT
  pragma: no-cache
  server: Kestrel
  transfer-encoding": "chunked",
  x-frame-options: DENY
  x-powered-by: ASP.NET