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
GenerateReferenceNumber Parameters:
NameParameterData TypeRequiredDescription
ApplianceIdqueryGuidYesAppliance to generate object reference for.
GenerateReferenceNumberResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringNo
ResponseStatusformResponseStatusNo

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