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

// @ApiResponse(Description="Returns the generated unique reference number for the specified object")
export class GenerateReferenceNumberResponse
{
    public Reference: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GenerateReferenceNumberResponse>) { (Object as any).assign(this, init); }
}

/** @description Generate a unique reference number for the object. */
// @Api(Description="Generate a unique reference number for the object.")
export class GenerateReferenceNumber
{
    /** @description Appliance to generate object reference for. */
    // @ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")
    public ApplianceId: string;

    public constructor(init?: Partial<GenerateReferenceNumber>) { (Object as any).assign(this, init); }
}

TypeScript GenerateReferenceNumber DTOs

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

HTTP + OTHER

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/jsonl

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