| GET | /api/safetycommitment | ||
|---|---|---|---|
| GET | /api/terms |
"use strict";
export class GetTermsDetailsResponse {
/** @param {{DisplaySafetyCommitment?:boolean,SafetyCommitmentContent?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description Should Commitment to Safety be displayed? */
DisplaySafetyCommitment;
/**
* @type {string}
* @description Commitment to Safety HTML content. */
SafetyCommitmentContent;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetTermsDetails {
/** @param {{LicenseeContactId?:string,ContactId?:string,ContactTypeId?:string,ApplianceId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Accept terms for the specified licensee contact id. */
LicenseeContactId;
/**
* @type {string}
* @description Terms are being accepted by the specified contact id. */
ContactId;
/**
* @type {string}
* @description Contact Type e.g Real Person or Real Organisation. Defaults to real person. */
ContactTypeId;
/**
* @type {string}
* @description Accept terms for the specified appliance id. This is not required for Safety Commitment. */
ApplianceId;
}
JavaScript GetTermsDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}