TicketUserServices

<back to all web services

WeeklyPayoutPreviewRequest

Requires Authentication
Requires any of the roles:Admin, Admin
The following routes are available for this service:
POST/payouts/weekly/preview
GET POST/payouts/weekly/sheet
WeeklyPayoutPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
AsOfbodyDateTime?No
FrombodyDateTime?No
TobodyDateTime?No
WeeklyPayoutPreviewResult Parameters:
NameParameterData TypeRequiredDescription
RunDateformDateTimeNo
WindowFromInclusiveformDateTimeNo
WindowToInclusiveformDateTimeNo
SheetTitleformstringNo
TotalAmountformlongNo
RowCountformintNo
RowsformList<WeeklyPayoutPreviewRow>No
MissingBankInfoformList<WeeklyPayoutMissingBank>No
SkippedformList<WeeklyPayoutMissingBank>No
SheetCsvformstringNo
MissingBankCsvformstringNo
Si080PreviewformstringNo
StatusCodeformintNo
MessageformstringNo
WeeklyPayoutPreviewRow Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
EventNameformstringNo
TimeOfEventformDateTimeNo
DeildformstringNo
EventOwnerNameformstringNo
EventOwnerIdformintNo
TeamNumberformstringNo
KennitalaformstringNo
BankAccountformstringNo
BankGenderformstringNo
GrossAmountformlongNo
AmountformlongNo
WeeklyPayoutMissingBank Parameters:
NameParameterData TypeRequiredDescription
EventOwnerNameformstringNo
EventOwnerIdformintNo
TeamNumberformstringNo
EventIdformintNo
EventNameformstringNo
TimeOfEventformDateTimeNo
DeildformstringNo
AmountformlongNo
ReasonformstringNo

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

<WeeklyPayoutPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AsOf>0001-01-01T00:00:00</AsOf>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</WeeklyPayoutPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WeeklyPayoutPreviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <MissingBankCsv>String</MissingBankCsv>
  <MissingBankInfo>
    <WeeklyPayoutMissingBank>
      <Amount>0</Amount>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <Reason>String</Reason>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutMissingBank>
  </MissingBankInfo>
  <RowCount>0</RowCount>
  <Rows>
    <WeeklyPayoutPreviewRow>
      <Amount>0</Amount>
      <BankAccount>String</BankAccount>
      <BankGender>String</BankGender>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <GrossAmount>0</GrossAmount>
      <Kennitala>String</Kennitala>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutPreviewRow>
  </Rows>
  <RunDate>0001-01-01T00:00:00</RunDate>
  <SheetCsv>String</SheetCsv>
  <SheetTitle>String</SheetTitle>
  <Si080Preview>String</Si080Preview>
  <Skipped>
    <WeeklyPayoutMissingBank>
      <Amount>0</Amount>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <Reason>String</Reason>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutMissingBank>
  </Skipped>
  <StatusCode>0</StatusCode>
  <TotalAmount>0</TotalAmount>
  <WindowFromInclusive>0001-01-01T00:00:00</WindowFromInclusive>
  <WindowToInclusive>0001-01-01T00:00:00</WindowToInclusive>
</WeeklyPayoutPreviewResult>