| GET | /mobileb/organizations | Gets all organizations available to a mobile user via their business association. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<OrganizationBasicView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Type | form | OrganizationType | No | |
| SubOrganizations | form | List<OrganizationBasicView> | No |
| Name | Value |
|---|---|
| Unknown | 0 |
| Admin | 10 |
| Tenant | 20 |
| Location | 30 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /mobileb/organizations HTTP/1.1 Host: api.4spaces.io Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"data":[{"id":"00000000000000000000000000000000","name":"String","code":"String","parentId":"00000000000000000000000000000000"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}