TicketUserServices

<back to all web services

PayoutBatchGetRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET/payouts/batches/{Id}
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 IsbPayoutBatch:
    id: Optional[int] = None
    batch_type: Optional[str] = None
    operation_id: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    date_of_payment: Optional[datetime.datetime] = None
    row_count: Optional[int] = None
    total_amount: Optional[int] = None
    # @StringLength(2147483647)
    request_xml: Optional[str] = None

    # @StringLength(2147483647)
    response_xml: Optional[str] = None

    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IsbPayoutBatchRow:
    id: Optional[int] = None
    # @References(typeof(IsbPayoutBatch))
    batch_id: Optional[int] = None

    event_id: Optional[int] = None
    event_owner_id: Optional[int] = None
    kennitala: Optional[str] = None
    bank_account: Optional[str] = None
    amount: Optional[int] = None
    reference: Optional[str] = None
    status: Optional[str] = None
    error_code: Optional[str] = None
    error_text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayoutBatchGetResult:
    batch: Optional[IsbPayoutBatch] = None
    rows: Optional[List[IsbPayoutBatchRow]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayoutBatchGetRequest:
    id: Optional[int] = None

Python PayoutBatchGetRequest 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 /payouts/batches/{Id} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayoutBatchGetResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Batch xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:BatchType>String</d2p1:BatchType>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:DateOfPayment>0001-01-01T00:00:00</d2p1:DateOfPayment>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:OperationId>String</d2p1:OperationId>
    <d2p1:RequestXml>String</d2p1:RequestXml>
    <d2p1:ResponseXml>String</d2p1:ResponseXml>
    <d2p1:RowCount>0</d2p1:RowCount>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
  </Batch>
  <Message>String</Message>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:IsbPayoutBatchRow>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:BankAccount>String</d2p1:BankAccount>
      <d2p1:BatchId>0</d2p1:BatchId>
      <d2p1:ErrorCode>String</d2p1:ErrorCode>
      <d2p1:ErrorText>String</d2p1:ErrorText>
      <d2p1:EventId>0</d2p1:EventId>
      <d2p1:EventOwnerId>0</d2p1:EventOwnerId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Kennitala>String</d2p1:Kennitala>
      <d2p1:Reference>String</d2p1:Reference>
      <d2p1:Status>String</d2p1:Status>
    </d2p1:IsbPayoutBatchRow>
  </Rows>
  <StatusCode>0</StatusCode>
</PayoutBatchGetResult>