TicketUserServices

<back to all web services

RunRecurringChargeJobRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST/recurringPayments/run-charge
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class RecurringChargeJobSummary
    {
        public RecurringChargeJobSummary()
        {
            Log = new List<string>{};
        }

        public virtual bool MasterEnabled { get; set; }
        public virtual bool AutoSubmitEnabled { get; set; }
        public virtual bool DunningEnabled { get; set; }
        public virtual bool ExpireLapsedEnabled { get; set; }
        public virtual bool EndOfTermRevokeEnabled { get; set; }
        public virtual int ChargeHour { get; set; }
        public virtual int BatchSize { get; set; }
        public virtual DateTime AsOfUtc { get; set; }
        public virtual bool DryRun { get; set; }
        public virtual bool ChargeLive { get; set; }
        public virtual bool DunningLive { get; set; }
        public virtual int Charged { get; set; }
        public virtual int Declined { get; set; }
        public virtual int Ambiguous { get; set; }
        public virtual int SkippedAlreadyCharged { get; set; }
        public virtual int NullOwnerCharged { get; set; }
        public virtual int SkippedSinglePayment { get; set; }
        public virtual int ExpiredCards { get; set; }
        public virtual int EndOfTermClosed { get; set; }
        public virtual int EndOfTermRevoked { get; set; }
        public virtual int HardClosed { get; set; }
        public virtual int CappedClosed { get; set; }
        public virtual int ExpiredCardNotified { get; set; }
        public virtual int CheckFirst { get; set; }
        public virtual bool CircuitBroken { get; set; }
        public virtual string CircuitBreakerCode { get; set; }
        public virtual int WouldCharge { get; set; }
        public virtual int WouldStopHard { get; set; }
        public virtual int WouldStopCapped { get; set; }
        public virtual int WouldSms { get; set; }
        public virtual int WouldEmail { get; set; }
        public virtual int WouldClose { get; set; }
        public virtual int WouldExpire { get; set; }
        public virtual int WouldEndOfTermClose { get; set; }
        public virtual int WouldEndOfTermRevoke { get; set; }
        public virtual int SmsSent { get; set; }
        public virtual int Emails { get; set; }
        public virtual int Closed { get; set; }
        public virtual List<string> Log { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class RunRecurringChargeJobRequest
    {
        public virtual bool DryRun { get; set; }
        public virtual DateTime? AsOf { get; set; }
    }

}

C# RunRecurringChargeJobRequest 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 /recurringPayments/run-charge HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RunRecurringChargeJobRequest 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>
  <DryRun>false</DryRun>
</RunRecurringChargeJobRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringChargeJobSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Ambiguous>0</Ambiguous>
  <AsOfUtc>0001-01-01T00:00:00</AsOfUtc>
  <AutoSubmitEnabled>false</AutoSubmitEnabled>
  <BatchSize>0</BatchSize>
  <CappedClosed>0</CappedClosed>
  <ChargeHour>0</ChargeHour>
  <ChargeLive>false</ChargeLive>
  <Charged>0</Charged>
  <CheckFirst>0</CheckFirst>
  <CircuitBreakerCode>String</CircuitBreakerCode>
  <CircuitBroken>false</CircuitBroken>
  <Closed>0</Closed>
  <Declined>0</Declined>
  <DryRun>false</DryRun>
  <DunningEnabled>false</DunningEnabled>
  <DunningLive>false</DunningLive>
  <Emails>0</Emails>
  <EndOfTermClosed>0</EndOfTermClosed>
  <EndOfTermRevokeEnabled>false</EndOfTermRevokeEnabled>
  <EndOfTermRevoked>0</EndOfTermRevoked>
  <ExpireLapsedEnabled>false</ExpireLapsedEnabled>
  <ExpiredCardNotified>0</ExpiredCardNotified>
  <ExpiredCards>0</ExpiredCards>
  <HardClosed>0</HardClosed>
  <Log xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Log>
  <MasterEnabled>false</MasterEnabled>
  <Message>String</Message>
  <NullOwnerCharged>0</NullOwnerCharged>
  <SkippedAlreadyCharged>0</SkippedAlreadyCharged>
  <SkippedSinglePayment>0</SkippedSinglePayment>
  <SmsSent>0</SmsSent>
  <StatusCode>0</StatusCode>
  <WouldCharge>0</WouldCharge>
  <WouldClose>0</WouldClose>
  <WouldEmail>0</WouldEmail>
  <WouldEndOfTermClose>0</WouldEndOfTermClose>
  <WouldEndOfTermRevoke>0</WouldEndOfTermRevoke>
  <WouldExpire>0</WouldExpire>
  <WouldSms>0</WouldSms>
  <WouldStopCapped>0</WouldStopCapped>
  <WouldStopHard>0</WouldStopHard>
</RecurringChargeJobSummary>