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 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns the response status")
class TermsActionResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    TermsActionResponse({this.ResponseStatus});
    TermsActionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "TermsActionResponse";
    TypeContext? context = _ctx;
}

/**
* Decline the specified terms for the contact.
*/
// @Api(Description="Decline the specified terms for the contact.")
class DeclineTerms implements IConvertible
{
    /**
    * Decline terms for the specified licensee contact id.
    */
    // @ApiMember(DataType="Guid", Description="Decline terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
    String? LicenseeContactId;

    /**
    * 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")
    String? ContactId;

    /**
    * 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")
    String? ContactTypeId;

    /**
    * 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")
    String? ApplianceId;

    DeclineTerms({this.LicenseeContactId,this.ContactId,this.ContactTypeId,this.ApplianceId});
    DeclineTerms.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LicenseeContactId = json['LicenseeContactId'];
        ContactId = json['ContactId'];
        ContactTypeId = json['ContactTypeId'];
        ApplianceId = json['ApplianceId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'LicenseeContactId': LicenseeContactId,
        'ContactId': ContactId,
        'ContactTypeId': ContactTypeId,
        'ApplianceId': ApplianceId
    };

    getTypeName() => "DeclineTerms";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'TermsActionResponse': TypeInfo(TypeOf.Class, create:() => TermsActionResponse()),
    'DeclineTerms': TypeInfo(TypeOf.Class, create:() => DeclineTerms()),
});

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