#Script Pages

<back to all web services

QueryCustomers

"use strict";
export class QueryBase {
    /** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    skip;
    /** @type {?number} */
    take;
    /** @type {string} */
    orderBy;
    /** @type {string} */
    orderByDesc;
    /** @type {string} */
    include;
    /** @type {string} */
    fields;
    /** @type {{ [index: string]: string; }} */
    meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
    /** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class Order {
    /** @param {{orderId?:number,customerId?:string,orderDate?:string,total?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    orderId;
    /** @type {string} */
    customerId;
    /** @type {string} */
    orderDate;
    /** @type {number} */
    total;
}
export class Customer {
    /** @param {{customerId?:string,companyName?:string,address?:string,city?:string,region?:string,postalCode?:string,country?:string,phone?:string,fax?:string,orders?:Order[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    customerId;
    /** @type {string} */
    companyName;
    /** @type {string} */
    address;
    /** @type {string} */
    city;
    /** @type {string} */
    region;
    /** @type {string} */
    postalCode;
    /** @type {string} */
    country;
    /** @type {string} */
    phone;
    /** @type {string} */
    fax;
    /** @type {Order[]} */
    orders;
}
export class QueryCustomers extends QueryDb {
    /** @param {{customerId?:string,companyNameContains?:string,countryIn?:string[],skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    customerId;
    /** @type {string} */
    companyNameContains;
    /** @type {string[]} */
    countryIn;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    offset;
    /** @type {number} */
    total;
    /** @type {T[]} */
    results;
    /** @type {{ [index: string]: string; }} */
    meta;
    /** @type {ResponseStatus} */
    responseStatus;
}

JavaScript QueryCustomers 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/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"customerId":"String","companyNameContains":"String","countryIn":["String"],"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":[{"customerId":"String","companyName":"String","address":"String","city":"String","region":"String","postalCode":"String","country":"String","phone":"String","fax":"String","orders":[{"orderId":0,"customerId":"String","orderDate":"\/Date(-62135596800000-0000)\/","total":0}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}