| POST | /api/safetycommitment/accept | ||
|---|---|---|---|
| POST | /api/terms/accept |
// @ApiResponse(Description="Returns the response status")
export class TermsActionResponse
{
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<TermsActionResponse>) { (Object as any).assign(this, init); }
}
/** @description Accept the specified terms for the specified licensee and contact. */
// @Api(Description="Accept the specified terms for the specified licensee and contact.")
export class AcceptTerms
{
/** @description 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 LicenseeContactId: string;
/** @description 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 ContactId: string;
/** @description 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 ContactTypeId: string;
/** @description 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 ApplianceId: string;
public constructor(init?: Partial<AcceptTerms>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}}