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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GiftCardHoldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AmountMinor>0</AmountMinor>
  <Code>String</Code>
  <EventId>0</EventId>
  <IdempotencyKey>String</IdempotencyKey>
  <OrderPaymentReference>String</OrderPaymentReference>
  <TargetOwnerId>0</TargetOwnerId>
</GiftCardHoldRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardHoldResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <HeldAmountMinor>0</HeldAmountMinor>
  <HoldId>0</HoldId>
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <RemainingAvailableMinor>0</RemainingAvailableMinor>
  <StatusCode>0</StatusCode>
</GiftCardHoldResult>