TicketUserServices

<back to all web services

DonationConfigUpsertRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/donationConfig

export class DonationConfigUpsertRequest
{
    public ownerId?: number;
    public ownerCardTypeId?: number;
    public isEnabled?: boolean;
    public charityRegistered?: boolean;
    public charityValidFromUTC?: string;
    public charityValidToUTC?: string;
    public minAmount?: number;
    public maxAmount?: number;
    public suggestedAmounts?: string;
    public defaultAmount?: number;
    public label?: string;
    public donationOnly?: boolean;

    public constructor(init?: Partial<DonationConfigUpsertRequest>) { (Object as any).assign(this, init); }
}

export class OwnerDonationConfig
{
    public id?: number;
    public ownerId?: number;
    public ownerCardTypeId?: number;
    public isEnabled?: boolean;
    public charityRegistered?: boolean;
    public charityValidFromUTC?: string;
    public charityValidToUTC?: string;
    public minAmount?: number;
    public maxAmount?: number;
    public suggestedAmounts?: string;
    public defaultAmount?: number;
    public label?: string;
    public donationOnly?: boolean;
    public timeStampCreatedUTC?: string;
    public timeStampLastChangedUTC?: string;

    public constructor(init?: Partial<OwnerDonationConfig>) { (Object as any).assign(this, init); }
}

export class DonationConfigResult
{
    public item?: OwnerDonationConfig;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<DonationConfigResult>) { (Object as any).assign(this, init); }
}

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

<DonationConfigUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CharityRegistered>false</CharityRegistered>
  <CharityValidFromUTC>0001-01-01T00:00:00</CharityValidFromUTC>
  <CharityValidToUTC>0001-01-01T00:00:00</CharityValidToUTC>
  <DefaultAmount>0</DefaultAmount>
  <DonationOnly>false</DonationOnly>
  <IsEnabled>false</IsEnabled>
  <Label>String</Label>
  <MaxAmount>0</MaxAmount>
  <MinAmount>0</MinAmount>
  <OwnerCardTypeId>0</OwnerCardTypeId>
  <OwnerId>0</OwnerId>
  <SuggestedAmounts>String</SuggestedAmounts>
</DonationConfigUpsertRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationConfigResult 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:CharityRegistered>false</d2p1:CharityRegistered>
    <d2p1:CharityValidFromUTC>0001-01-01T00:00:00</d2p1:CharityValidFromUTC>
    <d2p1:CharityValidToUTC>0001-01-01T00:00:00</d2p1:CharityValidToUTC>
    <d2p1:DefaultAmount>0</d2p1:DefaultAmount>
    <d2p1:DonationOnly>false</d2p1:DonationOnly>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:IsEnabled>false</d2p1:IsEnabled>
    <d2p1:Label>String</d2p1:Label>
    <d2p1:MaxAmount>0</d2p1:MaxAmount>
    <d2p1:MinAmount>0</d2p1:MinAmount>
    <d2p1:OwnerCardTypeId>0</d2p1:OwnerCardTypeId>
    <d2p1:OwnerId>0</d2p1:OwnerId>
    <d2p1:SuggestedAmounts>String</d2p1:SuggestedAmounts>
    <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>
</DonationConfigResult>