MigrantLeap.Auth

<back to all web services

GetUsers

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

// @DataContract
export class ResponseStatus implements IMeta
{
    // @DataMember(Order=1)
    public statusCode: number;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ResponseError[];

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse
{
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class MUser
{
    public id?: string;
    public email?: string;
    public firstName?: string;
    public lastName?: string;
    public country?: string;
    public language?: string;
    public birthDate?: string;
    public address?: string;
    public address2?: string;
    public city?: string;
    public state?: string;
    public zipCode?: string;
    public phoneNumber?: string;
    public emailConfirmed: boolean;
    public healthId?: string;
    public memberId?: string;
    public subscription?: string;

    public constructor(init?: Partial<MUser>) { (Object as any).assign(this, init); }
}

export class GetUsersResponse extends BaseResponse
{
    public users: MUser[];

    public constructor(init?: Partial<GetUsersResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetUsers
{

    public constructor(init?: Partial<GetUsers>) { (Object as any).assign(this, init); }
}

TypeScript GetUsers 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 /api/v1/users HTTP/1.1 
Host: auth.migrantleap.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	users: 
	[
		{
			id: String,
			email: String,
			firstName: String,
			lastName: String,
			country: String,
			language: String,
			birthDate: String,
			address: String,
			address2: String,
			city: String,
			state: String,
			zipCode: String,
			phoneNumber: String,
			emailConfirmed: False,
			healthId: String,
			memberId: String,
			subscription: String
		}
	],
	responseStatus: 
	{
		statusCode: 0,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}