Richemont.Booster2.PublicApi

<back to all web services

GetUsers

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Security.ServiceModel;

namespace Richemont.Booster2.PublicApi.Security.ServiceModel
{
    public partial class GetUserResponse
    {
        ///<summary>
        ///Unique Identifier of a User
        ///</summary>
        [ApiMember(Description="Unique Identifier of a User", IsRequired=true)]
        public virtual Guid userId { get; set; }

        ///<summary>
        ///User's Email address
        ///</summary>
        [ApiMember(Description="User's Email address", IsRequired=true)]
        public virtual string emailAddress { get; set; }

        ///<summary>
        ///First Name
        ///</summary>
        [ApiMember(Description="First Name", IsRequired=true)]
        public virtual string firstName { get; set; }

        ///<summary>
        ///Last Name
        ///</summary>
        [ApiMember(Description="Last Name", IsRequired=true)]
        public virtual string lastName { get; set; }

        ///<summary>
        ///User's Password Expiration Date
        ///</summary>
        [ApiMember(Description="User's Password Expiration Date")]
        public virtual string passwordExpirationDate { get; set; }

        ///<summary>
        ///If the User must change the password
        ///</summary>
        [ApiMember(Description="If the User must change the password", IsRequired=true)]
        public virtual bool passwordMustBeChanged { get; set; }

        ///<summary>
        ///User Type of the User
        ///</summary>
        [ApiMember(Description="User Type of the User", IsRequired=true)]
        public virtual string userType { get; set; }

        ///<summary>
        ///Culture ID of the User
        ///</summary>
        [ApiMember(Description="Culture ID of the User", IsRequired=true)]
        public virtual string culture { get; set; }

        ///<summary>
        ///If the User account is locked
        ///</summary>
        [ApiMember(Description="If the User account is locked", IsRequired=true)]
        public virtual bool accountLocked { get; set; }
    }

    public partial class GetUsers
        : IPagedRequest
    {
        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }

        ///<summary>
        ///Sorting expression
        ///</summary>
        [ApiMember(Description="Sorting expression")]
        public virtual string sortBy { get; set; }

        ///<summary>
        ///Email address
        ///</summary>
        [ApiMember(Description="Email address")]
        public virtual string email { get; set; }

        ///<summary>
        ///Also retreive users with locked account
        ///</summary>
        [ApiMember(Description="Also retreive users with locked account")]
        public virtual bool? includeLockedAccounts { get; set; }
    }

    public partial class GetUsersResponse
    {
        ///<summary>
        ///Index of the result set returnedr
        ///</summary>
        [ApiMember(Description="Index of the result set returnedr", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///Total amount of pages / result sets
        ///</summary>
        [ApiMember(Description="Total amount of pages / result sets", IsRequired=true)]
        public virtual int totalPages { get; set; }

        ///<summary>
        ///Total amount of results
        ///</summary>
        [ApiMember(Description="Total amount of results", IsRequired=true)]
        public virtual int totalResults { get; set; }

        ///<summary>
        ///List of Users
        ///</summary>
        [ApiMember(Description="List of Users", IsRequired=true)]
        public virtual IEnumerable<GetUserResponse> elements { get; set; }
    }

}

C# GetUsers DTOs

GET /users HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

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

<GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetUsersResponse>