Foundry API

<back to all web services

GetOrganisationMembershipRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{OrganisationId}/{UserId}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetOrganisationMembershipRequest extends GetOperationTenanted<GetOrganisationMembershipResponse>
    {
        public String userId = null;
        
        public String getUserId() { return userId; }
        public GetOrganisationMembershipRequest setUserId(String value) { this.userId = value; return this; }
    }

    public static class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public GetOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetOrganisationMembershipResponse
    {
        public ResponseStatus responseStatus = null;
        public OrganisationMembership membership = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetOrganisationMembershipResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public OrganisationMembership getMembership() { return membership; }
        public GetOrganisationMembershipResponse setMembership(OrganisationMembership value) { this.membership = value; return this; }
    }

    public static class OrganisationMembership implements IIdentifiableResource
    {
        public String userEmailAddress = null;
        public String userId = null;
        public String organisationId = null;
        public AccountType accountType = null;
        public Boolean isOwner = null;
        public Boolean isConfirmed = null;
        public ArrayList<String> roles = null;
        public String id = null;
        
        public String getUserEmailAddress() { return userEmailAddress; }
        public OrganisationMembership setUserEmailAddress(String value) { this.userEmailAddress = value; return this; }
        public String getUserId() { return userId; }
        public OrganisationMembership setUserId(String value) { this.userId = value; return this; }
        public String getOrganisationId() { return organisationId; }
        public OrganisationMembership setOrganisationId(String value) { this.organisationId = value; return this; }
        public AccountType getAccountType() { return accountType; }
        public OrganisationMembership setAccountType(AccountType value) { this.accountType = value; return this; }
        public Boolean getIsOwner() { return isOwner; }
        public OrganisationMembership setIsOwner(Boolean value) { this.isOwner = value; return this; }
        public Boolean getIsConfirmed() { return isConfirmed; }
        public OrganisationMembership setIsConfirmed(Boolean value) { this.isConfirmed = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public OrganisationMembership setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public String getId() { return id; }
        public OrganisationMembership setId(String value) { this.id = value; return this; }
    }

    public static enum AccountType
    {
        Person,
        Machine;
    }

}

Java GetOrganisationMembershipRequest DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetOrganisationMembershipResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <Membership xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:AccountType>Person</d2p1:AccountType>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsConfirmed>false</d2p1:IsConfirmed>
    <d2p1:IsOwner>false</d2p1:IsOwner>
    <d2p1:OrganisationId>String</d2p1:OrganisationId>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Roles>
    <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress>
    <d2p1:UserId>String</d2p1:UserId>
  </Membership>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetOrganisationMembershipResponse>