Platform API

<back to all web services

DeclineTerms

Decline the specified terms for the contact.

Requires Authentication
The following routes are available for this service:
POST/api/safetycommitment/decline
POST/api/terms/decline

// @ApiResponse(Description="Returns the response status")
export class TermsActionResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<TermsActionResponse>) { (Object as any).assign(this, init); }
}

/** @description Decline the specified terms for the contact. */
// @Api(Description="Decline the specified terms for the contact.")
export class DeclineTerms
{
    /** @description Decline terms for the specified licensee contact id. */
    // @ApiMember(DataType="Guid", Description="Decline terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
    public LicenseeContactId: string;

    /** @description Terms are being declined by the specified contact id. */
    // @ApiMember(DataType="Guid", Description="Terms are being declined 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 Decline terms for the specified appliance id. This is not required for Safety Commitment. */
    // @ApiMember(DataType="Guid", Description="Decline terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
    public ApplianceId: string;

    public constructor(init?: Partial<DeclineTerms>) { (Object as any).assign(this, init); }
}

TypeScript DeclineTerms DTOs

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/decline 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"}}}