| 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 .jsv suffix or ?format=jsv
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: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
members:
[
{
userEmailAddress: String,
userId: String,
organisationId: String,
accountType: Person,
isOwner: False,
isConfirmed: False,
roles:
[
String
],
id: String
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
]
}
}
}