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

import Foundation
import ServiceStack

/**
* 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.")
public class GetTermsDetails : Codable
{
    /**
    * 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 var licenseeContactId:String

    /**
    * 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 var contactId:String

    /**
    * 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 var contactTypeId:String

    /**
    * 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 var applianceId:String

    required public init(){}
}

public class GetTermsDetailsResponse : Codable
{
    /**
    * Should Commitment to Safety be displayed?
    */
    // @ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
    public var displaySafetyCommitment:Bool

    /**
    * Commitment to Safety HTML content.
    */
    // @ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")
    public var safetyCommitmentContent:String

    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift GetTermsDetails DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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