Trendsic Platform Service

<back to all web services

AvailableGiftCardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AvailableGiftCard/{AgentId}
<?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 GiftCard implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $GiftCardId=0,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $CardType=null,
        /** @var string|null */
        public ?string $CardNumber=null,
        /** @var int */
        public int $ContactId=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var DateTime */
        public DateTime $DateModified=new DateTime(),
        /** @var DateTime */
        public DateTime $DateDeleted=new DateTime(),
        /** @var string|null */
        public ?string $GiftCardGameSetId=null,
        /** @var DateTime */
        public DateTime $FirstApptDate=new DateTime(),
        /** @var bool|null */
        public ?bool $IsReferrerCard=null,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var string|null */
        public ?string $ContactName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['GiftCardId'])) $this->GiftCardId = $o['GiftCardId'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['CardType'])) $this->CardType = $o['CardType'];
        if (isset($o['CardNumber'])) $this->CardNumber = $o['CardNumber'];
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateModified'])) $this->DateModified = JsonConverters::from('DateTime', $o['DateModified']);
        if (isset($o['DateDeleted'])) $this->DateDeleted = JsonConverters::from('DateTime', $o['DateDeleted']);
        if (isset($o['GiftCardGameSetId'])) $this->GiftCardGameSetId = $o['GiftCardGameSetId'];
        if (isset($o['FirstApptDate'])) $this->FirstApptDate = JsonConverters::from('DateTime', $o['FirstApptDate']);
        if (isset($o['IsReferrerCard'])) $this->IsReferrerCard = $o['IsReferrerCard'];
        if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
        if (isset($o['ContactName'])) $this->ContactName = $o['ContactName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->GiftCardId)) $o['GiftCardId'] = $this->GiftCardId;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->CardType)) $o['CardType'] = $this->CardType;
        if (isset($this->CardNumber)) $o['CardNumber'] = $this->CardNumber;
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateModified)) $o['DateModified'] = JsonConverters::to('DateTime', $this->DateModified);
        if (isset($this->DateDeleted)) $o['DateDeleted'] = JsonConverters::to('DateTime', $this->DateDeleted);
        if (isset($this->GiftCardGameSetId)) $o['GiftCardGameSetId'] = $this->GiftCardGameSetId;
        if (isset($this->FirstApptDate)) $o['FirstApptDate'] = JsonConverters::to('DateTime', $this->FirstApptDate);
        if (isset($this->IsReferrerCard)) $o['IsReferrerCard'] = $this->IsReferrerCard;
        if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
        if (isset($this->ContactName)) $o['ContactName'] = $this->ContactName;
        return empty($o) ? new class(){} : $o;
    }
}

class GiftCardResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<GiftCard>|null */
        public ?array $GiftCard=null
    ) {
    }

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

class AvailableGiftCardRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0
    ) {
    }

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

PHP AvailableGiftCardRequest 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/AvailableGiftCard/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GiftCard>
    <GiftCard>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <CardNumber>String</CardNumber>
      <CardType>String</CardType>
      <ContactId>0</ContactId>
      <ContactName>String</ContactName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <FirstApptDate>0001-01-01T00:00:00</FirstApptDate>
      <GiftCardGameSetId>String</GiftCardGameSetId>
      <GiftCardId>0</GiftCardId>
      <IsReferrerCard>false</IsReferrerCard>
    </GiftCard>
  </GiftCard>
  <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>
</GiftCardResponse>