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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RecurringChargeJobSummary() = 
        member val MasterEnabled:Boolean = new Boolean() with get,set
        member val AutoSubmitEnabled:Boolean = new Boolean() with get,set
        member val DunningEnabled:Boolean = new Boolean() with get,set
        member val ExpireLapsedEnabled:Boolean = new Boolean() with get,set
        member val EndOfTermRevokeEnabled:Boolean = new Boolean() with get,set
        member val ChargeHour:Int32 = new Int32() with get,set
        member val BatchSize:Int32 = new Int32() with get,set
        member val AsOfUtc:DateTime = new DateTime() with get,set
        member val DryRun:Boolean = new Boolean() with get,set
        member val ChargeLive:Boolean = new Boolean() with get,set
        member val DunningLive:Boolean = new Boolean() with get,set
        member val Charged:Int32 = new Int32() with get,set
        member val Declined:Int32 = new Int32() with get,set
        member val Ambiguous:Int32 = new Int32() with get,set
        member val SkippedAlreadyCharged:Int32 = new Int32() with get,set
        member val NullOwnerCharged:Int32 = new Int32() with get,set
        member val SkippedSinglePayment:Int32 = new Int32() with get,set
        member val ExpiredCards:Int32 = new Int32() with get,set
        member val EndOfTermClosed:Int32 = new Int32() with get,set
        member val EndOfTermRevoked:Int32 = new Int32() with get,set
        member val HardClosed:Int32 = new Int32() with get,set
        member val CappedClosed:Int32 = new Int32() with get,set
        member val ExpiredCardNotified:Int32 = new Int32() with get,set
        member val CheckFirst:Int32 = new Int32() with get,set
        member val CircuitBroken:Boolean = new Boolean() with get,set
        member val CircuitBreakerCode:String = null with get,set
        member val WouldCharge:Int32 = new Int32() with get,set
        member val WouldStopHard:Int32 = new Int32() with get,set
        member val WouldStopCapped:Int32 = new Int32() with get,set
        member val WouldSms:Int32 = new Int32() with get,set
        member val WouldEmail:Int32 = new Int32() with get,set
        member val WouldClose:Int32 = new Int32() with get,set
        member val WouldExpire:Int32 = new Int32() with get,set
        member val WouldEndOfTermClose:Int32 = new Int32() with get,set
        member val WouldEndOfTermRevoke:Int32 = new Int32() with get,set
        member val SmsSent:Int32 = new Int32() with get,set
        member val Emails:Int32 = new Int32() with get,set
        member val Closed:Int32 = new Int32() with get,set
        member val Log:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type RunRecurringChargeJobRequest() = 
        member val DryRun:Boolean = new Boolean() with get,set
        member val AsOf:Nullable<DateTime> = new Nullable<DateTime>() with get,set

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

{
	dryRun: False,
	asOf: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	masterEnabled: False,
	autoSubmitEnabled: False,
	dunningEnabled: False,
	expireLapsedEnabled: False,
	endOfTermRevokeEnabled: False,
	chargeHour: 0,
	batchSize: 0,
	asOfUtc: 0001-01-01,
	dryRun: False,
	chargeLive: False,
	dunningLive: False,
	charged: 0,
	declined: 0,
	ambiguous: 0,
	skippedAlreadyCharged: 0,
	nullOwnerCharged: 0,
	skippedSinglePayment: 0,
	expiredCards: 0,
	endOfTermClosed: 0,
	endOfTermRevoked: 0,
	hardClosed: 0,
	cappedClosed: 0,
	expiredCardNotified: 0,
	checkFirst: 0,
	circuitBroken: False,
	circuitBreakerCode: String,
	wouldCharge: 0,
	wouldStopHard: 0,
	wouldStopCapped: 0,
	wouldSms: 0,
	wouldEmail: 0,
	wouldClose: 0,
	wouldExpire: 0,
	wouldEndOfTermClose: 0,
	wouldEndOfTermRevoke: 0,
	smsSent: 0,
	emails: 0,
	closed: 0,
	log: 
	[
		String
	],
	statusCode: 0,
	message: String
}