TicketUserServices

<back to all web services

GiftCardHoldRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Hold
namespace TicketUserServices.ServiceModel

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

    [<AllowNullLiteral>]
    type LocalizedMessage() = 
        member val Is:String = null with get,set
        member val En:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardHoldResult() = 
        member val Ok:Boolean = new Boolean() with get,set
        member val Reason:String = null with get,set
        member val Message:LocalizedMessage = null with get,set
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HeldAmountMinor:Int32 = new Int32() with get,set
        member val RemainingAvailableMinor:Int32 = new Int32() with get,set
        member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GiftCardHoldRequest() = 
        member val Code:String = null with get,set
        member val AmountMinor:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EventId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TargetOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OrderPaymentReference:String = null with get,set
        member val IdempotencyKey:String = null with get,set

F# GiftCardHoldRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GiftCard/Hold HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"code":"String","amountMinor":0,"eventId":0,"targetOwnerId":0,"orderPaymentReference":"String","idempotencyKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ok":false,"reason":"String","message":{"is":"String","en":"String"},"holdId":0,"heldAmountMinor":0,"remainingAvailableMinor":0,"expiresAt":"0001-01-01T00:00:00.0000000","statusCode":0}