Platform API

<back to all web services

GetTermsDetails

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

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

GET /api/safetycommitment HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

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