TicketUserServices

<back to all web services

DonationCreateRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/donation
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 DonationCreateRequest:
    owner_id: Optional[int] = None
    owner_card_type_id: Optional[int] = None
    owner_card_id: Optional[int] = None
    recurring_payment_id: Optional[int] = None
    payer_kennitala: Optional[str] = None
    payer_name: Optional[str] = None
    payer_email: Optional[str] = None
    amount: Optional[int] = None
    currency: Optional[str] = None
    paid_u_t_c: Optional[datetime.datetime] = None
    payment_reference: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Donation:
    id: Optional[int] = None
    owner_id: Optional[int] = None
    owner_card_type_id: Optional[int] = None
    owner_card_id: Optional[int] = None
    recurring_payment_id: Optional[int] = None
    payer_kennitala: Optional[str] = None
    payer_name: Optional[str] = None
    payer_email: Optional[str] = None
    amount: Optional[int] = None
    currency: Optional[str] = None
    paid_u_t_c: Optional[datetime.datetime] = None
    payment_reference: Optional[str] = None
    status: Optional[str] = None
    refunded_u_t_c: Optional[datetime.datetime] = None
    time_stamp_created_u_t_c: Optional[datetime.datetime] = None
    time_stamp_last_changed_u_t_c: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationResult:
    item: Optional[Donation] = None
    status_code: Optional[int] = None
    message: Optional[str] = None

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

<DonationCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Amount>0</Amount>
  <Currency>String</Currency>
  <OwnerCardId>0</OwnerCardId>
  <OwnerCardTypeId>0</OwnerCardTypeId>
  <OwnerId>0</OwnerId>
  <PaidUTC>0001-01-01T00:00:00</PaidUTC>
  <PayerEmail>String</PayerEmail>
  <PayerKennitala>String</PayerKennitala>
  <PayerName>String</PayerName>
  <PaymentReference>String</PaymentReference>
  <RecurringPaymentId>0</RecurringPaymentId>
</DonationCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:OwnerCardId>0</d2p1:OwnerCardId>
    <d2p1:OwnerCardTypeId>0</d2p1:OwnerCardTypeId>
    <d2p1:OwnerId>0</d2p1:OwnerId>
    <d2p1:PaidUTC>0001-01-01T00:00:00</d2p1:PaidUTC>
    <d2p1:PayerEmail>String</d2p1:PayerEmail>
    <d2p1:PayerKennitala>String</d2p1:PayerKennitala>
    <d2p1:PayerName>String</d2p1:PayerName>
    <d2p1:PaymentReference>String</d2p1:PaymentReference>
    <d2p1:RecurringPaymentId>0</d2p1:RecurringPaymentId>
    <d2p1:RefundedUTC>0001-01-01T00:00:00</d2p1:RefundedUTC>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:TimeStampCreatedUTC>0001-01-01T00:00:00</d2p1:TimeStampCreatedUTC>
    <d2p1:TimeStampLastChangedUTC>0001-01-01T00:00:00</d2p1:TimeStampLastChangedUTC>
  </Item>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</DonationResult>