GET | /sales/member/{MemberId}/profile/check | Check a customer for payment profile(s) |
---|
export class ApiDtoBase
{
public ApiKey: string;
public StoreId?: number;
public ChainId?: number;
public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}
export class CheckForPaymentProfileDto extends ApiDtoBase
{
public MemberId: number;
public constructor(init?: Partial<CheckForPaymentProfileDto>) { super(init); (Object as any).assign(this, init); }
}
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
export class CheckForPaymentProfile extends CheckForPaymentProfileDto implements IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
// @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
public ApiKey: string;
/**
* ID # of store member belongs to
*/
// @ApiMember(DataType="integer", Description="ID # of store member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
public StoreId: number;
/**
* ID # of user to check
*/
// @ApiMember(DataType="integer", Description="ID # of user to check", IsRequired=true, Name="MemberId", ParameterType="path")
public MemberId: number;
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
public constructor(init?: Partial<CheckForPaymentProfile>) { super(init); (Object as any).assign(this, init); }
}
TypeScript CheckForPaymentProfile 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.
GET /sales/member/{MemberId}/profile/check HTTP/1.1 Host: clubready.com Accept: application/xml