All Verbs | /orders | ||
---|---|---|---|
All Verbs | /orders/page/{Page} | ||
All Verbs | /customers/{CustomerId}/orders |
"use strict";
export class Order {
/** @param {{id?:number,customerId?:string,employeeId?:number,orderDate?:string,requiredDate?:string,shippedDate?:string,shipVia?:number,freight?:number,shipName?:string,shipAddress?:string,shipCity?:string,shipRegion?:string,shipPostalCode?:string,shipCountry?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
customerId;
/** @type {number} */
employeeId;
/** @type {?string} */
orderDate;
/** @type {?string} */
requiredDate;
/** @type {?string} */
shippedDate;
/** @type {?number} */
shipVia;
/** @type {number} */
freight;
/** @type {string} */
shipName;
/** @type {string} */
shipAddress;
/** @type {string} */
shipCity;
/** @type {string} */
shipRegion;
/** @type {string} */
shipPostalCode;
/** @type {string} */
shipCountry;
}
export class OrderDetail {
/** @param {{orderId?:number,productId?:number,unitPrice?:number,quantity?:number,discount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
orderId;
/** @type {number} */
productId;
/** @type {number} */
unitPrice;
/** @type {number} */
quantity;
/** @type {number} */
discount;
}
export class CustomerOrder {
/** @param {{order?:Order,orderDetails?:OrderDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Order} */
order;
/** @type {OrderDetail[]} */
orderDetails = [];
}
export class OrdersResponse {
/** @param {{results?:CustomerOrder[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CustomerOrder[]} */
results = [];
/** @type {ResponseStatus} */
responseStatus;
}
export class GetOrders {
/** @param {{page?:number,customerId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
page;
/** @type {string} */
customerId;
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /orders HTTP/1.1
Host: northwind.netcore.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"page":0,"customerId":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"results":[{"order":{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","shipVia":0,"freight":0,"shipName":"String","shipAddress":"String","shipCity":"String","shipRegion":"String","shipPostalCode":"String","shipCountry":"String"},"orderDetails":[{"orderId":0,"productId":0,"unitPrice":0,"quantity":0,"discount":0}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}