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

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

Namespace Global

    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 Overridable Property LicenseeContactId As Guid

            '''<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 Overridable Property ContactId As Guid

            '''<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 Overridable Property ContactTypeId As Guid

            '''<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 Overridable Property ApplianceId As Guid
        End Class

        Public Partial Class GetTermsDetailsResponse
            '''<Summary>
            '''Should Commitment to Safety be displayed?
            '''</Summary>
            <ApiMember(Description:="Should Commitment to Safety be displayed?", Name:="DisplaySafetyCommitment")>
            Public Overridable Property DisplaySafetyCommitment As Boolean

            '''<Summary>
            '''Commitment to Safety HTML content.
            '''</Summary>
            <ApiMember(Description:="Commitment to Safety HTML content.", Name:="SafetyCommitmentContent")>
            Public Overridable Property SafetyCommitmentContent As String

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>