GET api/account/companies?searchString={searchString}&take={take}&app={app}
Returns a list of organizations for which the user has at least one claim set.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchString |
If omitted, the API returns all of the companies the user has access to, ordered by the substring. Otherwise it returns only companies that contain the specified substring. The search is case-insensitive. |
string |
Default value is |
take |
The maximum number of organization to return. |
integer |
Default value is 10 |
app |
Application type name. Avalaibla values are "CPP", "retail" and "assets". The default value is "CPP". |
string |
Default value is CPP |
Body Parameters
None.
Response Information
Resource Description
Collection of OrganizationDTOName | Description | Type | Additional information |
---|---|---|---|
OrganizationId |
Organization ID. |
string |
None. |
OrganizationName |
Organization name. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "OrganizationId": "sample string 1", "OrganizationName": "sample string 2" }, { "OrganizationId": "sample string 1", "OrganizationName": "sample string 2" } ]
text/html
Sample:
[{"OrganizationId":"sample string 1","OrganizationName":"sample string 2"},{"OrganizationId":"sample string 1","OrganizationName":"sample string 2"}]
application/xml, text/xml
Sample:
<ArrayOfOrganizationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs"> <OrganizationDTO> <OrganizationId>sample string 1</OrganizationId> <OrganizationName>sample string 2</OrganizationName> </OrganizationDTO> <OrganizationDTO> <OrganizationId>sample string 1</OrganizationId> <OrganizationName>sample string 2</OrganizationName> </OrganizationDTO> </ArrayOfOrganizationDTO>