Foundry API

<back to all web services

SearchAllUsersRequest

import Foundation
import ServiceStack

public class SearchAllUsersRequest : SearchOperationTenanted<SearchAllUsersResponse>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class SearchOperationTenanted<TResponse : Codable> : SearchOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class SearchOperationUnTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
    public var distinct:String?
    public var limit:Int?
    public var offset:Int?
    public var sort:String?
    public var filter:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case distinct
        case limit
        case offset
        case sort
        case filter
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        distinct = try container.decodeIfPresent(String.self, forKey: .distinct)
        limit = try container.decodeIfPresent(Int.self, forKey: .limit)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        sort = try container.decodeIfPresent(String.self, forKey: .sort)
        filter = try container.decodeIfPresent(String.self, forKey: .filter)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if distinct != nil { try container.encode(distinct, forKey: .distinct) }
        if limit != nil { try container.encode(limit, forKey: .limit) }
        if offset != nil { try container.encode(offset, forKey: .offset) }
        if sort != nil { try container.encode(sort, forKey: .sort) }
        if filter != nil { try container.encode(filter, forKey: .filter) }
    }
}

public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class SearchAllUsersResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var userDetails:[UserDetails] = []

    required public init(){}
}

public class UserDetails : UserAccountMembership
{
    public var lastLoginDate:Date?
    public var twoFactorEnabled:Bool?
    public var name:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case lastLoginDate
        case twoFactorEnabled
        case name
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        lastLoginDate = try container.decodeIfPresent(Date.self, forKey: .lastLoginDate)
        twoFactorEnabled = try container.decodeIfPresent(Bool.self, forKey: .twoFactorEnabled)
        name = try container.decodeIfPresent(String.self, forKey: .name)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if lastLoginDate != nil { try container.encode(lastLoginDate, forKey: .lastLoginDate) }
        if twoFactorEnabled != nil { try container.encode(twoFactorEnabled, forKey: .twoFactorEnabled) }
        if name != nil { try container.encode(name, forKey: .name) }
    }
}

public class UserAccountMembership : IIdentifiableResource, Codable
{
    public var userId:String?
    public var userEmailAddress:String?
    public var status:AccountStatus?
    public var type:AccountType?
    public var roles:[String] = []
    public var id:String?
    public var organisationId:String?

    required public init(){}
}

public enum AccountStatus : String, Codable
{
    case Shadowed
    case Registered
}

public enum AccountType : String, Codable
{
    case Person
    case Machine
}

Swift SearchAllUsersRequest DTOs

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>