MigrantLeap.Auth

<back to all web services

GenerateOtpForUser

The following routes are available for this service:
POST/api/v1/generateotp
import Foundation
import ServiceStack

public class GenerateOtpForUser : Codable
{
    public var email:String
    public var phoneNumber:String

    required public init(){}
}

public class GenerateOtpForUserResponse : BaseResponse
{
    public var phoneNumber:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case phoneNumber
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if phoneNumber != nil { try container.encode(phoneNumber, forKey: .phoneNumber) }
    }
}

public class BaseResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}


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

POST /api/v1/generateotp HTTP/1.1 
Host: auth.migrantleap.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateOtpForUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MigrantLeap.Auth.v1.Models">
  <Email>String</Email>
  <PhoneNumber>String</PhoneNumber>
</GenerateOtpForUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateOtpForUserResponse 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>
  <PhoneNumber>String</PhoneNumber>
</GenerateOtpForUserResponse>