Platform API

<back to all web services

GetResetPasswordToken

Generate password reset token and send email

The following routes are available for this service:
All Verbs/api/account/{UserName}/passwordresettoken
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Generate password reset token and send email
    ///</summary>
    [Api(Description="Generate password reset token and send email")]
    public partial class GetResetPasswordToken
        : IPublicServiceModel
    {
        ///<summary>
        ///Get password reset token for the specified user name
        ///</summary>
        [ApiMember(Description="Get password reset token for the specified user name", Name="UserName")]
        public virtual string UserName { get; set; }

        public virtual Guid ApplianceId { get; set; }
        public virtual string SubdomainName { get; set; }
        public virtual Guid SuiteId { get; set; }
        ///<summary>
        ///Appliance Url for the appliance
        ///</summary>
        [ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")]
        public virtual string ApplianceLoginUrl { get; set; }
    }

    public partial class GetResetPasswordTokenResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetResetPasswordToken DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/account/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserName: String,
	SubdomainName: String,
	ApplianceLoginUrl: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}