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 Foundation
import ServiceStack

public class GiftCardHoldRequest : Codable
{
    public var code:String?
    public var amountMinor:Int?
    public var eventId:Int?
    public var targetOwnerId:Int?
    public var orderPaymentReference:String?
    public var idempotencyKey:String?

    required public init(){}
}

public class GiftCardHoldResult : Codable
{
    public var ok:Bool?
    public var reason:String?
    public var message:LocalizedMessage?
    public var holdId:Int?
    public var heldAmountMinor:Int?
    public var remainingAvailableMinor:Int?
    public var expiresAt:Date?
    public var statusCode:Int?

    required public init(){}
}

public class LocalizedMessage : Codable
{
    public var `is`:String?
    public var en:String?

    required public init(){}
}


Swift 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}