Platform API

<back to all web services

GetTermsDetails

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

Requires Authentication
The following routes are available for this service:
GET/api/safetycommitment
GET/api/terms
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* 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.")
open class GetTermsDetails
{
    /**
    * Accept terms for the specified licensee contact id.
    */
    @ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
    open var LicenseeContactId:UUID? = null

    /**
    * 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")
    open var ContactId:UUID? = null

    /**
    * 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")
    open var ContactTypeId:UUID? = null

    /**
    * 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")
    open var ApplianceId:UUID? = null
}

open class GetTermsDetailsResponse
{
    /**
    * Should Commitment to Safety be displayed?
    */
    @ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
    open var DisplaySafetyCommitment:Boolean? = null

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

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetTermsDetails DTOs

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

HTTP + OTHER

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