Foundry API

GetOrganisationMembershipRequest

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Organisations
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Enum AccountType
            Person
            Machine
        End Enum

        Public Partial Class OrganisationMembership
            Implements IIdentifiableResource
            Public Sub New()
                Roles = New List(Of String)
            End Sub

            Public Overridable Property UserEmailAddress As String
            Public Overridable Property UserId As String
            Public Overridable Property OrganisationId As String
            Public Overridable Property AccountType As AccountType
            Public Overridable Property IsOwner As Boolean
            Public Overridable Property IsConfirmed As Boolean
            Public Overridable Property Roles As List(Of String)
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations

        Public Partial Class GetOrganisationMembershipRequest
            Inherits GetOperationTenanted(Of GetOrganisationMembershipResponse)
            Public Overridable Property UserId As String
        End Class

        Public Partial Class GetOrganisationMembershipResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Membership As OrganisationMembership
        End Class
    End Namespace
End Namespace

VB.NET 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>