| Requires any of the roles: | Agent, Administrator |
| GET | /v1/Survey/GiftCard/{UID} |
|---|
<?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 SurveyQuestion implements JsonSerializable
{
public function __construct(
/** @var int */
public int $QuestionId=0,
/** @var string|null */
public ?string $QuestionType=null,
/** @var string|null */
public ?string $HTML=null,
/** @var string|null */
public ?string $DependsOn=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['QuestionId'])) $this->QuestionId = $o['QuestionId'];
if (isset($o['QuestionType'])) $this->QuestionType = $o['QuestionType'];
if (isset($o['HTML'])) $this->HTML = $o['HTML'];
if (isset($o['DependsOn'])) $this->DependsOn = $o['DependsOn'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->QuestionId)) $o['QuestionId'] = $this->QuestionId;
if (isset($this->QuestionType)) $o['QuestionType'] = $this->QuestionType;
if (isset($this->HTML)) $o['HTML'] = $this->HTML;
if (isset($this->DependsOn)) $o['DependsOn'] = $this->DependsOn;
return empty($o) ? new class(){} : $o;
}
}
class Survey implements JsonSerializable
{
public function __construct(
/** @var int */
public int $SurveyId=0,
/** @var int */
public int $ContactId=0,
/** @var array<SurveyQuestion>|null */
public ?array $Questions=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SurveyId'])) $this->SurveyId = $o['SurveyId'];
if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
if (isset($o['Questions'])) $this->Questions = JsonConverters::fromArray('SurveyQuestion', $o['Questions']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SurveyId)) $o['SurveyId'] = $this->SurveyId;
if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
if (isset($this->Questions)) $o['Questions'] = JsonConverters::toArray('SurveyQuestion', $this->Questions);
return empty($o) ? new class(){} : $o;
}
}
class GiftCardSurvey extends Survey implements JsonSerializable
{
/**
* @param int $SurveyId
* @param int $ContactId
* @param array<SurveyQuestion>|null $Questions
*/
public function __construct(
int $SurveyId=0,
int $ContactId=0,
?array $Questions=null,
/** @var int */
public int $GiftCardId=0,
/** @var array<string>|null */
public ?array $GiftCards=null
) {
parent::__construct($SurveyId,$ContactId,$Questions);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['GiftCardId'])) $this->GiftCardId = $o['GiftCardId'];
if (isset($o['GiftCards'])) $this->GiftCards = JsonConverters::fromArray('string', $o['GiftCards']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->GiftCardId)) $o['GiftCardId'] = $this->GiftCardId;
if (isset($this->GiftCards)) $o['GiftCards'] = JsonConverters::toArray('string', $this->GiftCards);
return empty($o) ? new class(){} : $o;
}
}
class GiftCardSurveyResponse implements JsonSerializable
{
public function __construct(
/** @var GiftCardSurvey|null */
public ?GiftCardSurvey $Survey=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Survey'])) $this->Survey = JsonConverters::from('GiftCardSurvey', $o['Survey']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Survey)) $o['Survey'] = JsonConverters::to('GiftCardSurvey', $this->Survey);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class GiftCardSurveyRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $UID=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['UID'])) $this->UID = $o['UID'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->UID)) $o['UID'] = $this->UID;
return empty($o) ? new class(){} : $o;
}
}
PHP GiftCardSurveyRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Survey/GiftCard/{UID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GiftCardSurveyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Survey>
<ContactId>0</ContactId>
<Questions>
<SurveyQuestion>
<DependsOn>String</DependsOn>
<HTML>String</HTML>
<QuestionId>0</QuestionId>
<QuestionType>String</QuestionType>
</SurveyQuestion>
</Questions>
<SurveyId>0</SurveyId>
<GiftCardId>0</GiftCardId>
<GiftCards xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</GiftCards>
</Survey>
</GiftCardSurveyResponse>