Billiecart API

<back to all web services

InitiatePasswordResetRequest

The following routes are available for this service:
POST/users/passwords/reset/initiate
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider
Imports Infrastructure.Api.Interfaces.ServiceOperations

Namespace Global

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider

        Public Partial Class InitiatePasswordResetRequest
            Inherits PostOperationUnTenanted(Of InitiatePasswordResetResponse)
            Public Overridable Property Email As String
        End Class

        Public Partial Class InitiatePasswordResetResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET InitiatePasswordResetRequest 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 /users/passwords/reset/initiate HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InitiatePasswordResetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider">
  <Email>String</Email>
</InitiatePasswordResetRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InitiatePasswordResetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.IdentityProvider">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</InitiatePasswordResetResponse>