All Verbs | /customers/{Id} |
---|
"use strict";
export class Customer {
/** @param {{id?:string,companyName?:string,contactName?:string,contactTitle?:string,address?:string,city?:string,region?:string,postalCode?:string,country?:string,phone?:string,fax?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
companyName;
/** @type {string} */
contactName;
/** @type {string} */
contactTitle;
/** @type {string} */
address;
/** @type {string} */
city;
/** @type {string} */
region;
/** @type {string} */
postalCode;
/** @type {string} */
country;
/** @type {string} */
phone;
/** @type {string} */
fax;
}
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 CustomerDetailsResponse {
/** @param {{customer?:Customer,orders?:CustomerOrder[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Customer} */
customer;
/** @type {CustomerOrder[]} */
orders = [];
/** @type {ResponseStatus} */
responseStatus;
}
export class GetCustomerDetails {
/** @param {{id?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
}
JavaScript GetCustomerDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{Id} HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { customer: { id: String, companyName: String, contactName: String, contactTitle: String, address: String, city: String, region: String, postalCode: String, country: String, phone: String, fax: String }, orders: [ { order: { id: 0, customerId: String, employeeId: 0, orderDate: 0001-01-01, requiredDate: 0001-01-01, shippedDate: 0001-01-01, 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 } } }