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
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GiftCardHoldRequest
{
    var code:String? = null
    var amountMinor:Int? = null
    var eventId:Int? = null
    var targetOwnerId:Int? = null
    var orderPaymentReference:String? = null
    var idempotencyKey:String? = null
}

open class GiftCardHoldResult
{
    var ok:Boolean? = null
    var reason:String? = null
    var message:LocalizedMessage? = null
    var holdId:Int? = null
    var heldAmountMinor:Int? = null
    var remainingAvailableMinor:Int? = null
    var expiresAt:Date? = null
    var statusCode:Int? = null
}

open class LocalizedMessage
{
    @SerializedName("is") var Is:String? = null
    var en:String? = null
}

Kotlin GiftCardHoldRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"code":"String","amountMinor":0,"eventId":0,"targetOwnerId":0,"orderPaymentReference":"String","idempotencyKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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}