Foundry API

<back to all web services

GetOrganisationMembershipRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{OrganisationId}/{UserId}
GetOrganisationMembershipRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetOrganisationMembershipResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MembershipformOrganisationMembershipNo
OrganisationMembership Parameters:
NameParameterData TypeRequiredDescription
UserEmailAddressformstringNo
UserIdformstringNo
OrganisationIdformstringNo
AccountTypeformAccountTypeNo
IsOwnerformboolNo
IsConfirmedformboolNo
RolesformList<string>No
IdformstringNo
AccountType Enum:
Person
Machine
GetOrganisationMembershipResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MembershipformOrganisationMembershipNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}