| GET | /api/v1/users |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseStatus(IMeta):
status_code: int = 0
message: Optional[str] = None
stack_trace: Optional[str] = None
errors: Optional[List[ResponseError]] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MUser:
id: Optional[str] = None
email: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
country: Optional[str] = None
language: Optional[str] = None
birth_date: Optional[str] = None
address: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip_code: Optional[str] = None
phone_number: Optional[str] = None
email_confirmed: bool = False
health_id: Optional[str] = None
member_id: Optional[str] = None
subscription: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUsersResponse(BaseResponse):
users: Optional[List[MUser]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUsers:
pass
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
}
}
}