| Requires the role: | Admin |
| 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 .xml suffix or ?format=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>