sfgboxapi

<back to all web services

MediaAutoQueryLookup


// @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<T> extends QueryBase
{

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

export class Media
{
    // @DataMember(Order=1)
    // @Required()
    public id: number;

    // @DataMember(Order=2)
    // @Required()
    // @References("typeof(sfgboxapi.ServiceModel.Types.Tenants)")
    public tenantsId: number;

    // @DataMember(Order=4)
    // @Required()
    public entity: string;

    // @DataMember(Order=5)
    // @Required()
    public entityId: number;

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

    // @DataMember(Order=7)
    public mediaPath?: string;

    // @DataMember(Order=8)
    // @References("typeof(sfgboxapi.ServiceModel.Types.Questionnairs)")
    public questionnairsId?: number;

    // @DataMember(Order=9)
    public name: string;

    // @DataMember(Order=10)
    public free: boolean;

    // @DataMember(Order=11)
    public publicAccessGuid: string;

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

export class MediaAutoQueryLookup extends QueryDb<Media>
{

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

export class Tenants
{
    // @DataMember(Order=1)
    // @Required()
    public id: number;

    // @DataMember(Order=2)
    // @Required()
    // @References("typeof(sfgboxapi.ServiceModel.Types.Zones)")
    public mainZonesId: number;

    // @DataMember(Order=3)
    public isPublic: boolean;

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

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

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

    // @DataMember(Order=3)
    public results: Tenants[];

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

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

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

TypeScript MediaAutoQueryLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/MediaAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"tenantsId":0,"entity":"String","entityId":0,"mediaType":"String","mediaPath":"String","questionnairsId":0,"name":"String","free":false,"publicAccessGuid":"00000000000000000000000000000000"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}