BokaMera.API.Host

<back to all web services

HomepageImagesQuery

// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

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

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @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 HomepageImageQueryResponse
{
    /** @description The company id. */
    // @ApiMember(Description="The company id.")
    public CompanyId: string;

    /** @description The homepage image id. */
    // @ApiMember(Description="The homepage image id.")
    public Id: number;

    /** @description The image title. */
    // @ApiMember(Description="The image title.")
    public Title: string;

    /** @description The image description. */
    // @ApiMember(Description="The image description.")
    public Description: string;

    /** @description The image url. */
    // @ApiMember(Description="The image url.")
    public ImageUrl: string;

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

export class BaseModel
{

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

export class HomepageImage extends BaseModel
{
    // @Required()
    public CompanyId: string;

    public Id: number;
    public Title?: string;
    public Description?: string;
    // @Required()
    public ImageUrl: string;

    public ModifiedDate?: string;

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

export class HomepageImagesQuery extends QueryDb<HomepageImage, HomepageImageQueryResponse> implements ICompanyRequest
{
    /** @description Enter the company you want to see news for, if blank and you are an admin, your company id will be used */
    // @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
    public CompanyId?: string;

    /** @description The image id. */
    // @ApiMember(Description="The image id.")
    public Id?: number;

    /** @description The homepage sitepath. */
    // @ApiMember(Description="The homepage sitepath.")
    public SitePath: string;

    public constructor(init?: Partial<HomepageImagesQuery>) { 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<T>
{
    // @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<T>>) { (Object as any).assign(this, init); }
}

TypeScript HomepageImagesQuery DTOs

GET /homepage/images 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: 
	[
		{
			Id: 0,
			Title: String,
			Description: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}