Platform API

<back to all web services

GenerateReferenceNumber

Generate a unique reference number for the object.

Requires Authentication
The following routes are available for this service:
GET/api/object/reference
"use strict";
export class GenerateReferenceNumberResponse {
    /** @param {{Reference?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reference;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GenerateReferenceNumber {
    /** @param {{ApplianceId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Appliance to generate object reference for. */
    ApplianceId;
}

JavaScript GenerateReferenceNumber DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}