Platform API

<back to all web services

AcceptTerms

Accept the specified terms for the specified licensee and contact.

Requires Authentication
The following routes are available for this service:
POST/api/safetycommitment/accept
POST/api/terms/accept
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Accept the specified terms for the specified licensee and contact.
*/
@Api(Description="Accept the specified terms for the specified licensee and contact.")
open class AcceptTerms
{
    /**
    * Accept terms for the specified licensee contact id.
    */
    @ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
    open var LicenseeContactId:UUID? = null

    /**
    * Terms are being accepted by the specified contact id.
    */
    @ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = 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")
    open var ContactTypeId:UUID? = null

    /**
    * Accept terms for the specified appliance id. This is not required for Safety Commitment.
    */
    @ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
    open var ApplianceId:UUID? = null
}

@ApiResponse(Description="Returns the response status")
open class TermsActionResponse
{
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin AcceptTerms 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/accept 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
		}
	}
}