TicketUserServices

<back to all web services

GiftCardSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/GiftCard/Search
GiftCardSearchRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardTypeIdbodyint?No
ScopebodystringNo
OwnerIdbodyint?No
StatusbodystringNo
CodeLast4bodystringNo
GiftCardSearchResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<GiftCardSummary>No
StatusCodeformintNo
MessageformstringNo
GiftCardSummary Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
GiftCardTypeIdformintNo
CodeLast4formstringNo
ScopeformstringNo
ScopeOwnerIdformint?No
CurrencyformstringNo
InitialValueMinorformintNo
CurrentBalanceMinorformintNo
StatusformstringNo
ActivatedAtformDateTime?No
ExpiresAtformDateTime?No
CreatedAtformDateTimeNo
BuyerNameformstringNo
BuyerEmailformstringNo
BuyerPhoneformstringNo
PaymentIdformstringNo
PaymentMethodIdformstringNo
PurchasePaymentReferenceformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GiftCard/Search HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"giftCardTypeId":0,"scope":"String","ownerId":0,"status":"String","codeLast4":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"id":0,"giftCardTypeId":0,"codeLast4":"String","scope":"String","scopeOwnerId":0,"currency":"String","initialValueMinor":0,"currentBalanceMinor":0,"status":"String","activatedAt":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","createdAt":"0001-01-01T00:00:00.0000000","buyerName":"String","buyerEmail":"String","buyerPhone":"String","paymentId":"String","paymentMethodId":"String","purchasePaymentReference":"String"}],"statusCode":0,"message":"String"}