Platform API

GetTermsDetails

Retrieve details of the specified terms for the specified licensee and contact.

The following routes are available for this service:
GET	/api/safetycommitment
GET	/api/terms


export class GetTermsDetailsResponse
{
    /** @description Should Commitment to Safety be displayed? */
    // @ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
    public DisplaySafetyCommitment: boolean;

    /** @description Commitment to Safety HTML content. */
    // @ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")
    public SafetyCommitmentContent: string;

    public ResponseStatus: ResponseStatus;

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

/** @description Retrieve details of the specified terms for the specified licensee and contact. */
// @Api(Description="Retrieve details of the specified terms for the specified licensee and contact.")
export class GetTermsDetails
{
    /** @description Accept terms for the specified licensee contact id. */
    // @ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
    public LicenseeContactId: string;

    /** @description Terms are being accepted by the specified contact id. */
    // @ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")
    public ContactId: string;

    /** @description Contact Type e.g Real Person or Real Organisation. Defaults to real person. */
    // @ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")
    public ContactTypeId: string;

    /** @description Accept terms for the specified appliance id. This is not required for Safety Commitment. */
    // @ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
    public ApplianceId: string;

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

TypeScript GetTermsDetails DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/safetycommitment HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DisplaySafetyCommitment: False,
	SafetyCommitmentContent: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}