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

"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 .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/safetycommitment HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

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

<GetTermsDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <DisplaySafetyCommitment>false</DisplaySafetyCommitment>
  <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>
  <SafetyCommitmentContent>String</SafetyCommitmentContent>
</GetTermsDetailsResponse>