| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| POST | /GiftCard/Search |
|---|
export class GiftCardSummary
{
public id?: number;
public giftCardTypeId?: number;
public codeLast4?: string;
public scope?: string;
public scopeOwnerId?: number;
public currency?: string;
public initialValueMinor?: number;
public currentBalanceMinor?: number;
public status?: string;
public activatedAt?: string;
public expiresAt?: string;
public createdAt?: string;
public buyerName?: string;
public buyerEmail?: string;
public buyerPhone?: string;
public paymentId?: string;
public paymentMethodId?: string;
public purchasePaymentReference?: string;
public constructor(init?: Partial<GiftCardSummary>) { (Object as any).assign(this, init); }
}
export class GiftCardSearchResult
{
public items?: GiftCardSummary[];
public statusCode?: number;
public message?: string;
public constructor(init?: Partial<GiftCardSearchResult>) { (Object as any).assign(this, init); }
}
export class GiftCardSearchRequest
{
public giftCardTypeId?: number;
public scope?: string;
public ownerId?: number;
public status?: string;
public codeLast4?: string;
public constructor(init?: Partial<GiftCardSearchRequest>) { (Object as any).assign(this, init); }
}
TypeScript GiftCardSearchRequest 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/Search HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GiftCardSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<CodeLast4>String</CodeLast4>
<GiftCardTypeId>0</GiftCardTypeId>
<OwnerId>0</OwnerId>
<Scope>String</Scope>
<Status>String</Status>
</GiftCardSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GiftCardSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Items>
<GiftCardSummary>
<ActivatedAt>0001-01-01T00:00:00</ActivatedAt>
<BuyerEmail>String</BuyerEmail>
<BuyerName>String</BuyerName>
<BuyerPhone>String</BuyerPhone>
<CodeLast4>String</CodeLast4>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<Currency>String</Currency>
<CurrentBalanceMinor>0</CurrentBalanceMinor>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<GiftCardTypeId>0</GiftCardTypeId>
<ID>0</ID>
<InitialValueMinor>0</InitialValueMinor>
<PaymentId>String</PaymentId>
<PaymentMethodId>String</PaymentMethodId>
<PurchasePaymentReference>String</PurchasePaymentReference>
<Scope>String</Scope>
<ScopeOwnerId>0</ScopeOwnerId>
<Status>String</Status>
</GiftCardSummary>
</Items>
<Message>String</Message>
<StatusCode>0</StatusCode>
</GiftCardSearchResult>