| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Hold |
|---|
export class LocalizedMessage
{
public is?: string;
public en?: string;
public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}
export class GiftCardHoldResult
{
public ok?: boolean;
public reason?: string;
public message?: LocalizedMessage;
public holdId?: number;
public heldAmountMinor?: number;
public remainingAvailableMinor?: number;
public expiresAt?: string;
public statusCode?: number;
public constructor(init?: Partial<GiftCardHoldResult>) { (Object as any).assign(this, init); }
}
export class GiftCardHoldRequest
{
public code?: string;
public amountMinor?: number;
public eventId?: number;
public targetOwnerId?: number;
public orderPaymentReference?: string;
public idempotencyKey?: string;
public constructor(init?: Partial<GiftCardHoldRequest>) { (Object as any).assign(this, init); }
}
TypeScript GiftCardHoldRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>