| GET | /api/safetycommitment | ||
|---|---|---|---|
| GET | /api/terms |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LicenseeContactId | query | Guid | Yes | Accept terms for the specified licensee contact id. |
| ContactId | query | Guid | Yes | Terms are being accepted by the specified contact id. |
| ContactTypeId | query | Guid | Yes | Contact Type e.g Real Person or Real Organisation. Defaults to real person. |
| ApplianceId | query | Guid | No | Accept terms for the specified appliance id. This is not required for Safety Commitment. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DisplaySafetyCommitment | form | bool | No | Should Commitment to Safety be displayed? |
| SafetyCommitmentContent | form | string | No | Commitment to Safety HTML content. |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DisplaySafetyCommitment":false,"SafetyCommitmentContent":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}