| POST | /api/v1/generateotp |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports MigrantLeap.Auth.v1.Models
Namespace Global
Namespace MigrantLeap.Auth.v1.Models
Public Partial Class BaseResponse
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class GenerateOtpForUser
Public Overridable Property Email As String
Public Overridable Property PhoneNumber As String
End Class
Public Partial Class GenerateOtpForUserResponse
Inherits BaseResponse
Public Overridable Property PhoneNumber As String
End Class
<DataContract>
Public Partial Class ResponseStatus
Implements IMeta
Public Sub New()
Errors = New List(Of ResponseError)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property StatusCode As Integer
<DataMember(Order:=2)>
Public Overridable Property Message As String
<DataMember(Order:=3)>
Public Overridable Property StackTrace As String
<DataMember(Order:=4)>
Public Overridable Property Errors As List(Of ResponseError)
<DataMember(Order:=5)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
End Namespace
End Namespace
VB.NET GenerateOtpForUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>