Foundry API

ListMembersForOrganisationRequest

The following routes are available for this service:
GET	/organisations/{Id}/members

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ListMembersForOrganisationRequest : SearchOperationUnTenanted<ListMembersForOrganisationResponse>()
{
    var id:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class ListMembersForOrganisationResponse : SearchOperationResponse()
{
    var responseStatus:ResponseStatus? = null
    var members:ArrayList<OrganisationMembership> = ArrayList<OrganisationMembership>()
}

open class SearchOperationResponse
{
    var metadata:SearchMetadata? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
}

open class OrganisationMembership : IIdentifiableResource
{
    var userEmailAddress:String? = null
    var userId:String? = null
    var organisationId:String? = null
    var accountType:AccountType? = null
    var isOwner:Boolean? = null
    var isConfirmed:Boolean? = null
    var roles:ArrayList<String> = ArrayList<String>()
    var id:String? = null
}

enum class AccountType
{
    Person,
    Machine,
}

Kotlin ListMembersForOrganisationRequest 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/{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>