Foundry API

SearchAllUsersRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public enum AccountStatus
    {
        Shadowed,
        Registered,
    }

    public enum AccountType
    {
        Person,
        Machine,
    }

    public partial class UserAccountMembership
        : IIdentifiableResource
    {
        public UserAccountMembership()
        {
            Roles = new List<string>{};
        }

        public virtual string UserId { get; set; }
        public virtual string UserEmailAddress { get; set; }
        public virtual AccountStatus Status { get; set; }
        public virtual AccountType Type { get; set; }
        public virtual List<string> Roles { get; set; }
        public virtual string Id { get; set; }
        public virtual string OrganisationId { get; set; }
    }

    public partial class UserDetails
        : UserAccountMembership
    {
        public virtual DateTime? LastLoginDate { get; set; }
        public virtual bool TwoFactorEnabled { get; set; }
        public virtual string Name { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

    public partial class SearchOperationTenanted<TResponse>
        : SearchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class SearchOperationUnTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, IHasSearchOptions
    {
        public virtual string Distinct { get; set; }
        public virtual int? Limit { get; set; }
        public virtual int? Offset { get; set; }
        public virtual string Sort { get; set; }
        public virtual string Filter { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts
{
    public partial class SearchAllUsersRequest
        : SearchOperationTenanted<SearchAllUsersResponse>
    {
    }

    public partial class SearchAllUsersResponse
    {
        public SearchAllUsersResponse()
        {
            UserDetails = new List<UserDetails>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<UserDetails> UserDetails { get; set; }
    }

}

C# SearchAllUsersRequest DTOs

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

HTTP + JSV

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: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	userDetails: 
	[
		{
			lastLoginDate: ,
			twoFactorEnabled: False,
			name: String,
			userId: String,
			userEmailAddress: String,
			status: Shadowed,
			type: Person,
			roles: 
			[
				String
			],
			id: String,
			organisationId: String
		}
	]
}