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
import Foundation
import ServiceStack

/**
* Decline the specified terms for the contact.
*/
// @Api(Description="Decline the specified terms for the contact.")
public class DeclineTerms : Codable
{
    /**
    * 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 var licenseeContactId:String

    /**
    * 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 var contactId:String

    /**
    * 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 var contactTypeId:String

    /**
    * 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 var applianceId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the response status")
public class TermsActionResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift DeclineTerms DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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