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
import Foundation
import ServiceStack

/**
* Accept the specified terms for the specified licensee and contact.
*/
// @Api(Description="Accept the specified terms for the specified licensee and contact.")
public class AcceptTerms : Codable
{
    /**
    * 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 var licenseeContactId:String

    /**
    * 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 var contactId:String

    /**
    * 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 var contactTypeId:String

    /**
    * 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 var applianceId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the response status")
public class TermsActionResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift AcceptTerms DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length

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