| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
| All Verbs | /ksiCards/Search | ||
|---|---|---|---|
| All Verbs | /ksiCards/Search/{Id} | ||
| All Verbs | /ksiCards/Search/Club/{KsiClubId}/{ExpiryYear} | ||
| All Verbs | /ksiCards/Search/Club/CardType/{KsiClubId}/{KsiCardType}/{ExpiryYear} |
export class KsiCards
{
public id?: number;
public creationDate?: string;
public phoneFullVerificationNumber?: string;
public deviceId?: string;
public ksiCardTypeId?: string;
public ksiClubId?: string;
public holderName?: string;
public canTransferToPhoneFullNumber?: string;
public canTransferToNName?: string;
public expYear?: string;
public expMonth?: string;
public isActive?: boolean;
public validFromDate?: string;
public validToDate?: string;
public lastModifiedDate?: string;
public revokedDate?: string;
public revokedReason?: string;
public constructor(init?: Partial<KsiCards>) { (Object as any).assign(this, init); }
}
export class KsiCardsSearchResult
{
public cards?: KsiCards[];
public statusCode?: number;
public message?: string;
public constructor(init?: Partial<KsiCardsSearchResult>) { (Object as any).assign(this, init); }
}
export class RequestSignature
{
public systemId?: string;
public systemSecret?: string;
public signature?: string;
public constructor(init?: Partial<RequestSignature>) { (Object as any).assign(this, init); }
}
export class KsiCardsSearchRequest
{
public id?: number;
public ksiClubId?: string;
public expiryYear?: string;
public ksiCardType?: string;
public fullPhoneNumber?: string;
public onlyValidForEventId?: number;
public includeInactive?: boolean;
public includeExpired?: boolean;
public requestUnixUTCTimeStamp?: number;
public signature?: RequestSignature;
public constructor(init?: Partial<KsiCardsSearchRequest>) { (Object as any).assign(this, init); }
}
TypeScript KsiCardsSearchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ksiCards/Search HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
ksiClubId: String,
expiryYear: String,
ksiCardType: String,
fullPhoneNumber: String,
onlyValidForEventId: 0,
includeInactive: False,
includeExpired: False,
requestUnixUTCTimeStamp: 0,
signature:
{
systemId: String,
systemSecret: String,
signature: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
cards:
[
{
id: 0,
creationDate: 0001-01-01,
phoneFullVerificationNumber: String,
deviceId: String,
ksiCardTypeId: String,
ksiClubId: String,
holderName: String,
canTransferToPhoneFullNumber: String,
canTransferToNName: String,
expYear: String,
expMonth: String,
isActive: False,
validFromDate: 0001-01-01,
validToDate: 0001-01-01,
lastModifiedDate: 0001-01-01,
revokedDate: 0001-01-01,
revokedReason: String
}
],
statusCode: 0,
message: String
}