Platform API

GenerateReferenceNumber

Generate a unique reference number for the object.

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="Returns the generated unique reference number for the specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GenerateReferenceNumberResponse:
    reference: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Generate a unique reference number for the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GenerateReferenceNumber:
    """
    Generate a unique reference number for the object.
    """

    # @ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")
    appliance_id: Optional[str] = None
    """
    Appliance to generate object reference for.
    """

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