BokaMera.API.Host

<back to all web services

AdminIncentiveActionQuery

// @DataContract
export class QueryBase
{
    /** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
    // @DataMember(Order=1)
    public Skip?: number;

    /** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
    // @DataMember(Order=2)
    public Take?: number;

    /** @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
    // @DataMember(Order=3)
    public OrderBy: string;

    /** @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
    // @DataMember(Order=4)
    public OrderByDesc: string;

    /** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
    // @DataMember(Order=5)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export enum IncentiveActionType
{
    Upgrade = 1,
    AddOn = 2,
    Information = 3,
}

export class IncentiveAction extends BaseModel
{
    public Id: number;
    public Description: string;
    public ActionType: IncentiveActionType;
    public Page: string;
    public Segment: string;
    public Element: string;
    public LicenseTypeId?: number;

    public constructor(init?: Partial<IncentiveAction>) { super(init); (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class AdminIncentiveActionQuery extends QueryDb<IncentiveAction, QueryResponse<IncentiveActionResponse>>
{
    public Id?: number;
    public CountryId: string;

    public constructor(init?: Partial<AdminIncentiveActionQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[];

    // @DataMember(Order=4)
    public Meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}

TypeScript AdminIncentiveActionQuery DTOs

GET /superadmin/incentives/action HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Offset: 0,
			Total: 0,
			Results: 
			[
				{
					Id: 0,
					Description: String,
					ActionType: Upgrade,
					Page: String,
					Segment: String,
					Element: String,
					LicenseTypeId: 0,
					SuggestedLicenseToUpgrade: 
					{
						Id: 0,
						Name: String,
						Description: String,
						IsExtraLicenseOption: False,
						PeriodOfNoticeDays: 0,
						Items: 
						[
							{
								Id: 0,
								Name: String,
								AllowedItems: 0
							}
						],
						Prices: 
						[
							{
								Country: 
								{
									CurrencyId: String,
									CurrencyInfo: 
									{
										Name: String,
										CurrencySign: String,
										Active: False,
										ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
										Id: String
									},
									Name: String,
									Culture: String,
									TimeZone: String,
									ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
									Id: String
								},
								MonthlyPayment: True,
								LicenseTypeId: 0,
								CountryId: String,
								Price: 0,
								ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
							}
						]
					}
				}
			],
			Meta: 
			{
				String: String
			},
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}