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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @ApiResponse(Description="Returns the response status")
class TermsActionResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Decline the specified terms for the contact. */
// @Api(Description="Decline the specified terms for the contact.")
class DeclineTerms implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string */
        public string $LicenseeContactId='',

        /** @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")
        /** @var string */
        public string $ContactId='',

        /** @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")
        /** @var string */
        public string $ContactTypeId='',

        /** @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")
        /** @var string */
        public string $ApplianceId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['LicenseeContactId'])) $this->LicenseeContactId = $o['LicenseeContactId'];
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['ContactTypeId'])) $this->ContactTypeId = $o['ContactTypeId'];
        if (isset($o['ApplianceId'])) $this->ApplianceId = $o['ApplianceId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->LicenseeContactId)) $o['LicenseeContactId'] = $this->LicenseeContactId;
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->ContactTypeId)) $o['ContactTypeId'] = $this->ContactTypeId;
        if (isset($this->ApplianceId)) $o['ApplianceId'] = $this->ApplianceId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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"}}}