| GET | /batch_view | ||
|---|---|---|---|
| GET | /batch_view/{Id} |
<?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};
// @DataContract
class QueryBase implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var int|null */
public ?int $Skip=null,
// @DataMember(Order=2)
/** @var int|null */
public ?int $Take=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $OrderBy=null,
// @DataMember(Order=4)
/** @var string|null */
public ?string $OrderByDesc=null,
// @DataMember(Order=5)
/** @var string|null */
public ?string $Include=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $Fields=null,
// @DataMember(Order=7)
/** @var array<string,string>|null */
public ?array $Meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Skip'])) $this->Skip = $o['Skip'];
if (isset($o['Take'])) $this->Take = $o['Take'];
if (isset($o['OrderBy'])) $this->OrderBy = $o['OrderBy'];
if (isset($o['OrderByDesc'])) $this->OrderByDesc = $o['OrderByDesc'];
if (isset($o['Include'])) $this->Include = $o['Include'];
if (isset($o['Fields'])) $this->Fields = $o['Fields'];
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Skip)) $o['Skip'] = $this->Skip;
if (isset($this->Take)) $o['Take'] = $this->Take;
if (isset($this->OrderBy)) $o['OrderBy'] = $this->OrderBy;
if (isset($this->OrderByDesc)) $o['OrderByDesc'] = $this->OrderByDesc;
if (isset($this->Include)) $o['Include'] = $this->Include;
if (isset($this->Fields)) $o['Fields'] = $this->Fields;
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template T
*/
class QueryDb extends QueryBase implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryDb {
$to = new QueryDb();
$to->genericArgs = $genericArgs;
return $to;
}
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
mixed $Skip=null,
mixed $Take=null,
mixed $OrderBy=null,
mixed $OrderByDesc=null,
mixed $Include=null,
mixed $Fields=null,
mixed $Meta=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
class BatchView implements JsonSerializable
{
public function __construct(
/** @var int|null */
public ?int $Id=null,
/** @var DateTime|null */
public ?DateTime $CreatedDate=null,
/** @var string|null */
public ?string $FileName=null,
/** @var string|null */
public ?string $FileSize=null,
/** @var int|null */
public ?int $RecordCount=null,
/** @var int|null */
public ?int $UserAuthId=null,
/** @var string */
public string $RowVersionGuid='',
/** @var int|null */
public ?int $InsertedRecords=null,
/** @var int|null */
public ?int $UpdatedRecords=null,
/** @var int|null */
public ?int $DeletedRecords=null,
/** @var string|null */
public ?string $UploadType=null,
/** @var int|null */
public ?int $StatusCodesId=null,
/** @var string|null */
public ?string $StatusCodeDescription=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTimeOffset', $o['CreatedDate']);
if (isset($o['FileName'])) $this->FileName = $o['FileName'];
if (isset($o['FileSize'])) $this->FileSize = $o['FileSize'];
if (isset($o['RecordCount'])) $this->RecordCount = $o['RecordCount'];
if (isset($o['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
if (isset($o['RowVersionGuid'])) $this->RowVersionGuid = $o['RowVersionGuid'];
if (isset($o['InsertedRecords'])) $this->InsertedRecords = $o['InsertedRecords'];
if (isset($o['UpdatedRecords'])) $this->UpdatedRecords = $o['UpdatedRecords'];
if (isset($o['DeletedRecords'])) $this->DeletedRecords = $o['DeletedRecords'];
if (isset($o['UploadType'])) $this->UploadType = $o['UploadType'];
if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
if (isset($o['StatusCodeDescription'])) $this->StatusCodeDescription = $o['StatusCodeDescription'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTimeOffset', $this->CreatedDate);
if (isset($this->FileName)) $o['FileName'] = $this->FileName;
if (isset($this->FileSize)) $o['FileSize'] = $this->FileSize;
if (isset($this->RecordCount)) $o['RecordCount'] = $this->RecordCount;
if (isset($this->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
if (isset($this->RowVersionGuid)) $o['RowVersionGuid'] = $this->RowVersionGuid;
if (isset($this->InsertedRecords)) $o['InsertedRecords'] = $this->InsertedRecords;
if (isset($this->UpdatedRecords)) $o['UpdatedRecords'] = $this->UpdatedRecords;
if (isset($this->DeletedRecords)) $o['DeletedRecords'] = $this->DeletedRecords;
if (isset($this->UploadType)) $o['UploadType'] = $this->UploadType;
if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
if (isset($this->StatusCodeDescription)) $o['StatusCodeDescription'] = $this->StatusCodeDescription;
return empty($o) ? new class(){} : $o;
}
}
/**
* @template QueryDb of BatchView
*/
class BatchViewQuery extends QueryDb implements IGet, JsonSerializable
{
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
?int $Skip=null,
?int $Take=null,
?string $OrderBy=null,
?string $OrderByDesc=null,
?string $Include=null,
?string $Fields=null,
?array $Meta=null,
/** @var int */
public int $UserAuthId=0
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['UserAuthId'])) $this->UserAuthId = $o['UserAuthId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->UserAuthId)) $o['UserAuthId'] = $this->UserAuthId;
return empty($o) ? new class(){} : $o;
}
}
class CampaignCustomersView implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var int|null */
public ?int $Id=null,
// @DataMember(Order=2)
/** @var string|null */
public ?string $Name=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $Description=null,
// @DataMember(Order=4)
/** @var int|null */
public ?int $CustomersId=null,
// @DataMember(Order=5)
/** @var string|null */
public ?string $FirstName=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $LastName=null,
// @DataMember(Order=7)
/** @var string|null */
public ?string $IdNumber=null,
// @DataMember(Order=8)
/** @var string|null */
public ?string $PassportNumber=null,
// @DataMember(Order=9)
/** @var string|null */
public ?string $Email=null,
// @DataMember(Order=10)
/** @var string|null */
public ?string $MobileNumber=null,
// @DataMember(Order=11)
/** @var string|null */
public ?string $CustomerUniqueIdentifier=null,
// @DataMember(Order=12)
/** @var string|null */
public ?string $CustomerPublicAccessGuid=null,
// @DataMember(Order=13)
/** @var string|null */
public ?string $CampaignPublicAccessGuid=null,
// @DataMember(Order=14)
/** @var int|null */
public ?int $TenantsId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
if (isset($o['LastName'])) $this->LastName = $o['LastName'];
if (isset($o['IdNumber'])) $this->IdNumber = $o['IdNumber'];
if (isset($o['PassportNumber'])) $this->PassportNumber = $o['PassportNumber'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['MobileNumber'])) $this->MobileNumber = $o['MobileNumber'];
if (isset($o['CustomerUniqueIdentifier'])) $this->CustomerUniqueIdentifier = $o['CustomerUniqueIdentifier'];
if (isset($o['CustomerPublicAccessGuid'])) $this->CustomerPublicAccessGuid = $o['CustomerPublicAccessGuid'];
if (isset($o['CampaignPublicAccessGuid'])) $this->CampaignPublicAccessGuid = $o['CampaignPublicAccessGuid'];
if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
if (isset($this->LastName)) $o['LastName'] = $this->LastName;
if (isset($this->IdNumber)) $o['IdNumber'] = $this->IdNumber;
if (isset($this->PassportNumber)) $o['PassportNumber'] = $this->PassportNumber;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->MobileNumber)) $o['MobileNumber'] = $this->MobileNumber;
if (isset($this->CustomerUniqueIdentifier)) $o['CustomerUniqueIdentifier'] = $this->CustomerUniqueIdentifier;
if (isset($this->CustomerPublicAccessGuid)) $o['CustomerPublicAccessGuid'] = $this->CustomerPublicAccessGuid;
if (isset($this->CampaignPublicAccessGuid)) $o['CampaignPublicAccessGuid'] = $this->CampaignPublicAccessGuid;
if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template T
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $Offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $Total=0,
// @DataMember(Order=3)
/** @var array<CampaignCustomersView>|null */
public mixed $Results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $Meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('CampaignCustomersView', $o['Results']);
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('CampaignCustomersView', $this->Results);
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
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 /batch_view HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfBatchViewqTGWvAI3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<d2p1:BatchView>
<d2p1:CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</d2p1:CreatedDate>
<d2p1:DeletedRecords>0</d2p1:DeletedRecords>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FileSize>String</d2p1:FileSize>
<d2p1:Id>0</d2p1:Id>
<d2p1:InsertedRecords>0</d2p1:InsertedRecords>
<d2p1:RecordCount>0</d2p1:RecordCount>
<d2p1:RowVersionGuid>00000000-0000-0000-0000-000000000000</d2p1:RowVersionGuid>
<d2p1:StatusCodeDescription>String</d2p1:StatusCodeDescription>
<d2p1:StatusCodesId>0</d2p1:StatusCodesId>
<d2p1:UpdatedRecords>0</d2p1:UpdatedRecords>
<d2p1:UploadType>String</d2p1:UploadType>
<d2p1:UserAuthId>0</d2p1:UserAuthId>
</d2p1:BatchView>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<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>
</Meta>
</ResponseError>
</Errors>
<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>
</Meta>
</ResponseStatus>
</QueryResponseOfBatchViewqTGWvAI3>