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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"batch":{"id":0,"batchType":"String","operationId":"String","createdAt":"0001-01-01T00:00:00.0000000","dateOfPayment":"0001-01-01T00:00:00.0000000","rowCount":0,"totalAmount":0,"requestXml":"String","responseXml":"String","status":"String"},"rows":[{"id":0,"batchId":0,"eventId":0,"eventOwnerId":0,"kennitala":"String","bankAccount":"String","amount":0,"reference":"String","status":"String","errorCode":"String","errorText":"String"}],"statusCode":0,"message":"String"}