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
AcceptTerms Parameters:
NameParameterData TypeRequiredDescription
LicenseeContactIdbodyGuidYesAccept terms for the specified licensee contact id.
ContactIdbodyGuidYesTerms are being accepted by the specified contact id.
ContactTypeIdbodyGuidYesContact Type e.g Real Person or Real Organisation. Defaults to real person.
ApplianceIdbodyGuidNoAccept terms for the specified appliance id. This is not required for Safety Commitment.
TermsActionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

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