MigrantLeap.Auth

<back to all web services

GetUsers

The following routes are available for this service:
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

Python GetUsers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: 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/MigrantLeap.Auth.v1.Models">
  <ResponseStatus>
    <StatusCode>0</StatusCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ResponseError>
        <d3p1:ErrorCode>String</d3p1:ErrorCode>
        <d3p1:FieldName>String</d3p1:FieldName>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d3p1:Meta>
      </d3p1:ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <Users>
    <MUser>
      <Address>String</Address>
      <Address2>String</Address2>
      <BirthDate>String</BirthDate>
      <City>String</City>
      <Country>String</Country>
      <Email>String</Email>
      <EmailConfirmed>false</EmailConfirmed>
      <FirstName>String</FirstName>
      <HealthId>String</HealthId>
      <Id>String</Id>
      <Language>String</Language>
      <LastName>String</LastName>
      <MemberId>String</MemberId>
      <PhoneNumber>String</PhoneNumber>
      <State>String</State>
      <Subscription>String</Subscription>
      <ZipCode>String</ZipCode>
    </MUser>
  </Users>
</GetUsersResponse>