TicketUserServices

<back to all web services

DonationRecurringCreateRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/donation/recurring
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 DonationRecurringCreateRequest:
    recurring_payment_id: Optional[int] = None
    amount: Optional[int] = 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 DonationRecurringCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /donation/recurring HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	recurringPaymentId: 0,
	amount: 0,
	paidUTC: 0001-01-01,
	paymentReference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		id: 0,
		ownerId: 0,
		ownerCardTypeId: 0,
		ownerCardId: 0,
		recurringPaymentId: 0,
		payerKennitala: String,
		payerName: String,
		payerEmail: String,
		amount: 0,
		currency: String,
		paidUTC: 0001-01-01,
		paymentReference: String,
		status: String,
		refundedUTC: 0001-01-01,
		timeStampCreatedUTC: 0001-01-01,
		timeStampLastChangedUTC: 0001-01-01
	},
	statusCode: 0,
	message: String
}