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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Decline the specified terms for the contact.
    ///</summary>
    [Api(Description="Decline the specified terms for the contact.")]
    public partial class DeclineTerms
    {
        ///<summary>
        ///Decline terms for the specified licensee contact id.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Decline terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")]
        public virtual Guid LicenseeContactId { get; set; }

        ///<summary>
        ///Terms are being declined by the specified contact id.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Terms are being declined by the specified contact id.", IsRequired=true, Name="ContactId")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///Contact Type e.g Real Person or Real Organisation. Defaults to real person.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")]
        public virtual Guid ContactTypeId { get; set; }

        ///<summary>
        ///Decline terms for the specified appliance id. This is not required for Safety Commitment.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Decline terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")]
        public virtual Guid ApplianceId { get; set; }
    }

    [ApiResponse(Description="Returns the response status")]
    public partial class TermsActionResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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"}}}