Platform API

<back to all web services

GetTermsDetails

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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 static 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")
        public UUID LicenseeContactId = 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")
        public UUID ContactId = 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")
        public UUID ContactTypeId = 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")
        public UUID ApplianceId = null;
        
        public UUID getLicenseeContactId() { return LicenseeContactId; }
        public GetTermsDetails setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
        public UUID getContactId() { return ContactId; }
        public GetTermsDetails setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getContactTypeId() { return ContactTypeId; }
        public GetTermsDetails setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public GetTermsDetails setApplianceId(UUID value) { this.ApplianceId = value; return this; }
    }

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

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

        public ResponseStatus ResponseStatus = null;
        
        public Boolean isDisplaySafetyCommitment() { return DisplaySafetyCommitment; }
        public GetTermsDetailsResponse setDisplaySafetyCommitment(Boolean value) { this.DisplaySafetyCommitment = value; return this; }
        public String getSafetyCommitmentContent() { return SafetyCommitmentContent; }
        public GetTermsDetailsResponse setSafetyCommitmentContent(String value) { this.SafetyCommitmentContent = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetTermsDetailsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java GetTermsDetails DTOs

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>