| Required role: | Tartarus.Read |
| GET,POST | /api/citi-bank-statement |
|---|
<?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};
enum BankEntryType : int
{
case Balance = 1;
case Transaction = 2;
}
class CitiBankAccountEntry implements JsonSerializable
{
public function __construct(
/** @var BankEntryType|null */
public ?BankEntryType $entryType=null,
/** @var string|null */
public ?string $description=null,
/** @var float|null */
public ?float $amount=null,
/** @var string|null */
public ?string $currencyCode=null,
/** @var string|null */
public ?string $creditDebitIndicator=null,
/** @var DateTime|null */
public ?DateTime $entryDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['entryType'])) $this->entryType = JsonConverters::from('BankEntryType', $o['entryType']);
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['amount'])) $this->amount = $o['amount'];
if (isset($o['currencyCode'])) $this->currencyCode = $o['currencyCode'];
if (isset($o['creditDebitIndicator'])) $this->creditDebitIndicator = $o['creditDebitIndicator'];
if (isset($o['entryDate'])) $this->entryDate = JsonConverters::from('DateTime', $o['entryDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->entryType)) $o['entryType'] = JsonConverters::to('BankEntryType', $this->entryType);
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->amount)) $o['amount'] = $this->amount;
if (isset($this->currencyCode)) $o['currencyCode'] = $this->currencyCode;
if (isset($this->creditDebitIndicator)) $o['creditDebitIndicator'] = $this->creditDebitIndicator;
if (isset($this->entryDate)) $o['entryDate'] = JsonConverters::to('DateTime', $this->entryDate);
return empty($o) ? new class(){} : $o;
}
}
class CitiBankEntriesResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var bool|null */
public ?bool $statementIsStillGenerating=null,
/** @var array<CitiBankAccountEntry>|null */
public ?array $entries=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['statementIsStillGenerating'])) $this->statementIsStillGenerating = $o['statementIsStillGenerating'];
if (isset($o['entries'])) $this->entries = JsonConverters::fromArray('CitiBankAccountEntry', $o['entries']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->statementIsStillGenerating)) $o['statementIsStillGenerating'] = $this->statementIsStillGenerating;
if (isset($this->entries)) $o['entries'] = JsonConverters::toArray('CitiBankAccountEntry', $this->entries);
return empty($o) ? new class(){} : $o;
}
}
class RetrieveCitiBankStatementRequest implements IGet, IPost, JsonSerializable
{
public function __construct(
/** @var string */
public string $statementId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['statementId'])) $this->statementId = $o['statementId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->statementId)) $o['statementId'] = $this->statementId;
return empty($o) ? new class(){} : $o;
}
}
PHP RetrieveCitiBankStatementRequest 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.
POST /api/citi-bank-statement HTTP/1.1
Host: tartarus.nephila.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RetrieveCitiBankStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
<StatementId>String</StatementId>
</RetrieveCitiBankStatementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CitiBankEntriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
<Entries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel.Types">
<d2p1:CitiBankAccountEntry>
<d2p1:Amount>0</d2p1:Amount>
<d2p1:CreditDebitIndicator>String</d2p1:CreditDebitIndicator>
<d2p1:CurrencyCode>String</d2p1:CurrencyCode>
<d2p1:Description>String</d2p1:Description>
<d2p1:EntryDate>0001-01-01T00:00:00</d2p1:EntryDate>
<d2p1:EntryType>Balance</d2p1:EntryType>
</d2p1:CitiBankAccountEntry>
</Entries>
<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>
<StatementIsStillGenerating>false</StatementIsStillGenerating>
</CitiBankEntriesResponse>