| GET | /api/v1/users |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Users | form | List<MUser> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | form | int | No | |
| Message | form | string | Yes | |
| StackTrace | form | string | Yes | |
| Errors | form | List<ResponseError> | Yes | |
| Meta | form | Dictionary<string, string> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| form | string | No | ||
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Country | form | string | No | |
| Language | form | string | No | |
| BirthDate | form | string | No | |
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| ZipCode | form | string | No | |
| PhoneNumber | form | string | No | |
| EmailConfirmed | form | bool | No | |
| HealthId | form | string | No | |
| MemberId | form | string | No | |
| Subscription | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}