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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class GiftCardHoldRequest
            Public Overridable Property Code As String
            Public Overridable Property AmountMinor As Nullable(Of Integer)
            Public Overridable Property EventId As Nullable(Of Integer)
            Public Overridable Property TargetOwnerId As Nullable(Of Integer)
            Public Overridable Property OrderPaymentReference As String
            Public Overridable Property IdempotencyKey As String
        End Class

        Public Partial Class GiftCardHoldResult
            Public Overridable Property Ok As Boolean
            Public Overridable Property Reason As String
            Public Overridable Property Message As LocalizedMessage
            Public Overridable Property HoldId As Nullable(Of Integer)
            Public Overridable Property HeldAmountMinor As Integer
            Public Overridable Property RemainingAvailableMinor As Integer
            Public Overridable Property ExpiresAt As Nullable(Of Date)
            Public Overridable Property StatusCode As Integer
        End Class

        Public Partial Class LocalizedMessage
            Public Overridable Property [Is] As String
            Public Overridable Property En As String
        End Class
    End Namespace
End Namespace

VB.NET GiftCardHoldRequest DTOs

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

HTTP + JSV

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

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

{
	ok: False,
	reason: String,
	message: 
	{
		is: String,
		en: String
	},
	holdId: 0,
	heldAmountMinor: 0,
	remainingAvailableMinor: 0,
	expiresAt: 0001-01-01,
	statusCode: 0
}