TicketUserServices

<back to all web services

GiftCardIssueRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Issue
GiftCardIssueRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardTypeIdbodyintNo
AmountMinorbodyintNo
CodebodystringNo
ActivatebodyboolNo
BuyerNamebodystringNo
BuyerEmailbodystringNo
BuyerPhonebodystringNo
RecipientNamebodystringNo
IdempotencyKeybodystringNo
NotebodystringNo
GiftCardIssueResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
GiftCardIdformint?No
CodeformstringNo
CodeLast4formstringNo
StatusformstringNo
ExpiresAtformDateTime?No
PaymentIdformstringNo
StatusCodeformintNo
MessageformstringNo

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/Issue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"giftCardTypeId":0,"amountMinor":0,"code":"String","activate":false,"buyerName":"String","buyerEmail":"String","buyerPhone":"String","recipientName":"String","idempotencyKey":"String","note":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false,"giftCardId":0,"code":"String","codeLast4":"String","status":"String","expiresAt":"0001-01-01T00:00:00.0000000","paymentId":"String","statusCode":0,"message":"String"}