Trendsic Platform Service

<back to all web services

RecordsExemptionsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/settings/exemptions
<?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};


class ExemptionDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Citation=null,
        /** @var string|null */
        public ?string $Clause=null
    ) {
    }

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

class RecordsExemptionsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<ExemptionDto>|null */
        public ?array $Government=null,
        /** @var array<ExemptionDto>|null */
        public ?array $Standard=null,
        /** @var string|null */
        public ?string $Mode=null
    ) {
    }

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

class RecordsExemptionsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP RecordsExemptionsRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/records/settings/exemptions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordsExemptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Government>
    <ExemptionDto>
      <Citation>String</Citation>
      <Clause>String</Clause>
      <Name>String</Name>
    </ExemptionDto>
  </Government>
  <Mode>String</Mode>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Standard>
    <ExemptionDto>
      <Citation>String</Citation>
      <Clause>String</Clause>
      <Name>String</Name>
    </ExemptionDto>
  </Standard>
</RecordsExemptionsResponse>