Platform API

DeclineTerms

Decline the specified terms for the contact.

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Decline the specified terms for the contact.
    */
    @Api(Description="Decline the specified terms for the contact.")
    public static class DeclineTerms
    {
        /**
        * 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 UUID LicenseeContactId = null;

        /**
        * 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 UUID ContactId = null;

        /**
        * 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 UUID ContactTypeId = null;

        /**
        * 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 UUID ApplianceId = null;
        
        public UUID getLicenseeContactId() { return LicenseeContactId; }
        public DeclineTerms setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
        public UUID getContactId() { return ContactId; }
        public DeclineTerms setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getContactTypeId() { return ContactTypeId; }
        public DeclineTerms setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public DeclineTerms setApplianceId(UUID value) { this.ApplianceId = value; return this; }
    }

    @ApiResponse(Description="Returns the response status")
    public static class TermsActionResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public TermsActionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java DeclineTerms DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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