Platform API

<back to all web services

AcceptTerms

Accept the specified terms for the specified licensee and contact.

Requires Authentication
The following routes are available for this service:
POST/api/safetycommitment/accept
POST/api/terms/accept
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>
        '''Accept the specified terms for the specified licensee and contact.
        '''</Summary>
        <Api(Description:="Accept the specified terms for the specified licensee and contact.")>
        Public Partial Class AcceptTerms
            '''<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

        <ApiResponse(Description:="Returns the response status")>
        Public Partial Class TermsActionResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET AcceptTerms DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/safetycommitment/accept HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LicenseeContactId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}