Platform API

GenerateReferenceNumber

Generate a unique reference number for the object.

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 .xml suffix or ?format=xml

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateReferenceNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <Reference>String</Reference>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GenerateReferenceNumberResponse>