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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Generate a unique reference number for the object.
    */
    @Api(Description="Generate a unique reference number for the object.")
    public static class GenerateReferenceNumber
    {
        /**
        * Appliance to generate object reference for.
        */
        @ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")
        public UUID ApplianceId = null;
        
        public UUID getApplianceId() { return ApplianceId; }
        public GenerateReferenceNumber setApplianceId(UUID value) { this.ApplianceId = value; return this; }
    }

    @ApiResponse(Description="Returns the generated unique reference number for the specified object")
    public static class GenerateReferenceNumberResponse
    {
        public String Reference = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getReference() { return Reference; }
        public GenerateReferenceNumberResponse setReference(String value) { this.Reference = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GenerateReferenceNumberResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java GenerateReferenceNumber DTOs

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

HTTP + CSV

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