MigrantLeap.Auth

<back to all web services

GetUsers

The following routes are available for this service:
GET/api/v1/users
GetUsersResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformList<MUser>Yes
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusYes
ResponseStatus Parameters:
NameParameterData TypeRequiredDescription
StatusCodeformintNo
MessageformstringYes
StackTraceformstringYes
ErrorsformList<ResponseError>Yes
MetaformDictionary<string, string>Yes
MUser Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
CountryformstringNo
LanguageformstringNo
BirthDateformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipCodeformstringNo
PhoneNumberformstringNo
EmailConfirmedformboolNo
HealthIdformstringNo
MemberIdformstringNo
SubscriptionformstringNo

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