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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class RecurringChargeJobSummary
            Public Sub New()
                Log = New List(Of String)
            End Sub

            Public Overridable Property MasterEnabled As Boolean
            Public Overridable Property AutoSubmitEnabled As Boolean
            Public Overridable Property DunningEnabled As Boolean
            Public Overridable Property ExpireLapsedEnabled As Boolean
            Public Overridable Property EndOfTermRevokeEnabled As Boolean
            Public Overridable Property ChargeHour As Integer
            Public Overridable Property BatchSize As Integer
            Public Overridable Property AsOfUtc As Date
            Public Overridable Property DryRun As Boolean
            Public Overridable Property ChargeLive As Boolean
            Public Overridable Property DunningLive As Boolean
            Public Overridable Property Charged As Integer
            Public Overridable Property Declined As Integer
            Public Overridable Property Ambiguous As Integer
            Public Overridable Property SkippedAlreadyCharged As Integer
            Public Overridable Property NullOwnerCharged As Integer
            Public Overridable Property SkippedSinglePayment As Integer
            Public Overridable Property ExpiredCards As Integer
            Public Overridable Property EndOfTermClosed As Integer
            Public Overridable Property EndOfTermRevoked As Integer
            Public Overridable Property HardClosed As Integer
            Public Overridable Property CappedClosed As Integer
            Public Overridable Property ExpiredCardNotified As Integer
            Public Overridable Property CheckFirst As Integer
            Public Overridable Property CircuitBroken As Boolean
            Public Overridable Property CircuitBreakerCode As String
            Public Overridable Property WouldCharge As Integer
            Public Overridable Property WouldStopHard As Integer
            Public Overridable Property WouldStopCapped As Integer
            Public Overridable Property WouldSms As Integer
            Public Overridable Property WouldEmail As Integer
            Public Overridable Property WouldClose As Integer
            Public Overridable Property WouldExpire As Integer
            Public Overridable Property WouldEndOfTermClose As Integer
            Public Overridable Property WouldEndOfTermRevoke As Integer
            Public Overridable Property SmsSent As Integer
            Public Overridable Property Emails As Integer
            Public Overridable Property Closed As Integer
            Public Overridable Property Log As List(Of String)
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class RunRecurringChargeJobRequest
            Public Overridable Property DryRun As Boolean
            Public Overridable Property AsOf As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET 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>