GET | /organisations/{OrganisationId}/{UserId} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Membership | form | OrganisationMembership | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserEmailAddress | form | string | No | |
UserId | form | string | No | |
OrganisationId | form | string | No | |
AccountType | form | AccountType | No | |
IsOwner | form | bool | No | |
IsConfirmed | form | bool | No | |
Roles | form | List<string> | No | |
Id | form | string | No |
Person | |
Machine |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Membership | form | OrganisationMembership | No |
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 /organisations/{OrganisationId}/{UserId} HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"membership":{"userEmailAddress":"String","userId":"String","organisationId":"String","accountType":"Person","isOwner":false,"isConfirmed":false,"roles":["String"],"id":"String"}}