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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<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.")]
    public partial class 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")]
        public virtual Guid LicenseeContactId { 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")]
        public virtual Guid ContactId { 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")]
        public virtual Guid ContactTypeId { 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")]
        public virtual Guid ApplianceId { get; set; }
    }

    public partial class GetTermsDetailsResponse
    {
        ///<summary>
        ///Should Commitment to Safety be displayed?
        ///</summary>
        [ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")]
        public virtual bool DisplaySafetyCommitment { get; set; }

        ///<summary>
        ///Commitment to Safety HTML content.
        ///</summary>
        [ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")]
        public virtual string SafetyCommitmentContent { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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>