Foundry API

GetOrganisationMembershipRequest

The following routes are available for this service:
GET	/organisations/{OrganisationId}/{UserId}

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


open class GetOrganisationMembershipRequest : GetOperationTenanted<GetOrganisationMembershipResponse>()
{
    var userId:String? = null
}

open class GetOperationTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

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

open class GetOrganisationMembershipResponse
{
    var responseStatus:ResponseStatus? = null
    var membership:OrganisationMembership? = null
}

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 GetOrganisationMembershipRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}