Platform API

GenerateReferenceNumber

Generate a unique reference number for the object.

The following routes are available for this service:
GET	/api/object/reference

namespace Eros.Saguna.Common.WebAPIModel.ServiceModels

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns the generated unique reference number for the specified object")>]
    [<AllowNullLiteral>]
    type GenerateReferenceNumberResponse() = 
        member val Reference:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Generate a unique reference number for the object.
    ///</summary>
    [<Api(Description="Generate a unique reference number for the object.")>]
    [<AllowNullLiteral>]
    type GenerateReferenceNumber() = 
        ///<summary>
        ///Appliance to generate object reference for.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")>]
        member val ApplianceId:Guid = new Guid() with get,set

F# GenerateReferenceNumber 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.

GET /api/object/reference HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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