Foundry API

SearchAllUsersRequest

The following routes are available for this service:
GET	/users/all

namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type AccountStatus =
        | Shadowed = 0
        | Registered = 1

    type AccountType =
        | Person = 0
        | Machine = 1

    [<AllowNullLiteral>]
    type UserAccountMembership() = 
        member val UserId:String = null with get,set
        member val UserEmailAddress:String = null with get,set
        member val Status:AccountStatus = new AccountStatus() with get,set
        member val Type:AccountType = new AccountType() with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Id:String = null with get,set
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type UserDetails() = 
        inherit UserAccountMembership()
        member val LastLoginDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type SearchAllUsersResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val UserDetails:ResizeArray<UserDetails> = new ResizeArray<UserDetails>() with get,set

    [<AllowNullLiteral>]
    type SearchAllUsersRequest() = 
        inherit SearchOperationTenanted<SearchAllUsersResponse>()

    [<AllowNullLiteral>]
    type SearchOperationTenanted<'TResponse>() = 
        inherit SearchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type SearchOperationUnTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val Distinct:String = null with get,set
        member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Sort:String = null with get,set
        member val Filter:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# SearchAllUsersRequest 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 /users/all HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: application/xml

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

<SearchAllUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
  <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>
  <UserDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:UserDetails>
      <d2p1:Id>String</d2p1:Id>
      <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:Status>Shadowed</d2p1:Status>
      <d2p1:Type>Person</d2p1:Type>
      <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress>
      <d2p1:UserId>String</d2p1:UserId>
      <d2p1:LastLoginDate>0001-01-01T00:00:00</d2p1:LastLoginDate>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
    </d2p1:UserDetails>
  </UserDetails>
</SearchAllUsersResponse>