Platform API

GenerateReferenceNumber

Generate a unique reference number for the object.

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Generate a unique reference number for the object.
*/
@Api(Description="Generate a unique reference number for the object.")
open class GenerateReferenceNumber
{
    /**
    * Appliance to generate object reference for.
    */
    @ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")
    open var ApplianceId:UUID? = null
}

@ApiResponse(Description="Returns the generated unique reference number for the specified object")
open class GenerateReferenceNumberResponse
{
    open var Reference:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}