Nephila Tartarus

<back to all web services

InitiateCitiBankStatementRequest

Cash
Requires Authentication
Required role:Tartarus.Read
The following routes are available for this service:
GET,POST/api/initiate-citi-bank-statement
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InitiateCitiBankStatementResponse:
    response_status: Optional[ResponseStatus] = None
    statement_is_still_generating: bool = False
    statement_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InitiateCitiBankStatementRequest(IGet, IPost):
    bank_account_number: Optional[str] = None
    from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    to_date: datetime.datetime = datetime.datetime(1, 1, 1)
    format_name: Optional[str] = None

Python InitiateCitiBankStatementRequest 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.

POST /api/initiate-citi-bank-statement HTTP/1.1 
Host: tartarus.nephila.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InitiateCitiBankStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
  <BankAccountNumber>String</BankAccountNumber>
  <FormatName>String</FormatName>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
</InitiateCitiBankStatementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InitiateCitiBankStatementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nephila.Tartarus.ServiceModel">
  <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>
  <StatementId>String</StatementId>
  <StatementIsStillGenerating>false</StatementIsStillGenerating>
</InitiateCitiBankStatementResponse>