Foundry API

<back to all web services

SearchAllUsersRequest

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

public class dtos
{

    public static class SearchAllUsersRequest extends SearchOperationTenanted<SearchAllUsersResponse>
    {
        
    }

    public static class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public SearchOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
    {
        public String distinct = null;
        public Integer limit = null;
        public Integer offset = null;
        public String sort = null;
        public String filter = null;
        
        public String getDistinct() { return distinct; }
        public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
        public String getSort() { return sort; }
        public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
        public String getFilter() { return filter; }
        public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class SearchAllUsersResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<UserDetails> userDetails = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SearchAllUsersResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<UserDetails> getUserDetails() { return userDetails; }
        public SearchAllUsersResponse setUserDetails(ArrayList<UserDetails> value) { this.userDetails = value; return this; }
    }

    public static class UserDetails extends UserAccountMembership
    {
        public Date lastLoginDate = null;
        public Boolean twoFactorEnabled = null;
        public String name = null;
        
        public Date getLastLoginDate() { return lastLoginDate; }
        public UserDetails setLastLoginDate(Date value) { this.lastLoginDate = value; return this; }
        public Boolean isTwoFactorEnabled() { return twoFactorEnabled; }
        public UserDetails setTwoFactorEnabled(Boolean value) { this.twoFactorEnabled = value; return this; }
        public String getName() { return name; }
        public UserDetails setName(String value) { this.name = value; return this; }
    }

    public static class UserAccountMembership implements IIdentifiableResource
    {
        public String userId = null;
        public String userEmailAddress = null;
        public AccountStatus status = null;
        public AccountType type = null;
        public ArrayList<String> roles = null;
        public String id = null;
        public String organisationId = null;
        
        public String getUserId() { return userId; }
        public UserAccountMembership setUserId(String value) { this.userId = value; return this; }
        public String getUserEmailAddress() { return userEmailAddress; }
        public UserAccountMembership setUserEmailAddress(String value) { this.userEmailAddress = value; return this; }
        public AccountStatus getStatus() { return status; }
        public UserAccountMembership setStatus(AccountStatus value) { this.status = value; return this; }
        public AccountType getType() { return type; }
        public UserAccountMembership setType(AccountType value) { this.type = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public UserAccountMembership setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public String getId() { return id; }
        public UserAccountMembership setId(String value) { this.id = value; return this; }
        public String getOrganisationId() { return organisationId; }
        public UserAccountMembership setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static enum AccountStatus
    {
        Shadowed,
        Registered;
    }

    public static enum AccountType
    {
        Person,
        Machine;
    }

}

Java 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>