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