Foundry API

<back to all web services

ListMembersForOrganisationRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ListMembersForOrganisationRequest extends SearchOperationUnTenanted<ListMembersForOrganisationResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public ListMembersForOrganisationRequest setId(String value) { this.id = value; return this; }
    }

    public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
    {
        public String distinct = null;
        public Integer limit = null;
        public Integer offset = null;
        public String sort = null;
        public String filter = null;
        
        public String getDistinct() { return distinct; }
        public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
        public String getSort() { return sort; }
        public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
        public String getFilter() { return filter; }
        public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = 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 ListMembersForOrganisationResponse extends SearchOperationResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<OrganisationMembership> members = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ListMembersForOrganisationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<OrganisationMembership> getMembers() { return members; }
        public ListMembersForOrganisationResponse setMembers(ArrayList<OrganisationMembership> value) { this.members = value; return this; }
    }

    public static class SearchOperationResponse
    {
        public SearchMetadata metadata = null;
        
        public SearchMetadata getMetadata() { return metadata; }
        public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
    }

    public static class SearchMetadata
    {
        public Integer total = null;
        public Integer limit = null;
        public Integer offset = null;
        public Sorting sort = null;
        public Filtering filter = null;
        
        public Integer getTotal() { return total; }
        public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
        public Sorting getSort() { return sort; }
        public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
        public Filtering getFilter() { return filter; }
        public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
    }

    public static class Sorting
    {
        public String by = null;
        public SortDirection direction = null;
        
        public String getBy() { return by; }
        public Sorting setBy(String value) { this.by = value; return this; }
        public SortDirection getDirection() { return direction; }
        public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
    }

    public static enum SortDirection
    {
        Ascending,
        Descending;
    }

    public static class Filtering
    {
        public ArrayList<String> fields = null;
        
        public ArrayList<String> getFields() { return fields; }
        public Filtering setFields(ArrayList<String> value) { this.fields = 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 ListMembersForOrganisationRequest DTOs

GET /organisations/{Id}/members HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListMembersForOrganisationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <Members xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:OrganisationMembership>
      <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Roles>
      <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress>
      <d2p1:UserId>String</d2p1:UserId>
    </d2p1:OrganisationMembership>
  </Members>
  <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>
</ListMembersForOrganisationResponse>