TicketUserServices

<back to all web services

PayoutBatchListRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET/payouts/batches
PayoutBatchListRequest Parameters:
NameParameterData TypeRequiredDescription
Limitqueryint?No
PayoutBatchListResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<IsbPayoutBatch>No
StatusCodeformintNo
MessageformstringNo
IsbPayoutBatch Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BatchTypeformstringNo
OperationIdformstringNo
CreatedAtformDateTimeNo
DateOfPaymentformDateTime?No
RowCountformintNo
TotalAmountformlongNo
RequestXmlformstringNo
ResponseXmlformstringNo
StatusformstringNo

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 HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayoutBatchListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:IsbPayoutBatch>
      <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>
    </d2p1:IsbPayoutBatch>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</PayoutBatchListResult>