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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetTermsDetailsResponse() = 
        ///<summary>
        ///Should Commitment to Safety be displayed?
        ///</summary>
        [<ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")>]
        member val DisplaySafetyCommitment:Boolean = new Boolean() with get,set

        ///<summary>
        ///Commitment to Safety HTML content.
        ///</summary>
        [<ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")>]
        member val SafetyCommitmentContent:String = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Retrieve details of the specified terms for the specified licensee and contact.
    ///</summary>
    [<Api(Description="Retrieve details of the specified terms for the specified licensee and contact.")>]
    [<AllowNullLiteral>]
    type GetTermsDetails() = 
        ///<summary>
        ///Accept terms for the specified licensee contact id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")>]
        member val LicenseeContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Terms are being accepted by the specified contact id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Contact Type e.g Real Person or Real Organisation. Defaults to real person.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")>]
        member val ContactTypeId:Guid = new Guid() with get,set

        ///<summary>
        ///Accept terms for the specified appliance id. This is not required for Safety Commitment.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")>]
        member val ApplianceId:Guid = new Guid() with get,set

F# 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"}}}