All Verbs | /customers |
---|
"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 CustomersResponse {
/** @param {{results?:Customer[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Customer[]} */
results;
/** @type {ResponseStatus} */
responseStatus;
}
export class GetAllCustomers {
constructor(init) { Object.assign(this, init) }
}
JavaScript GetAllCustomers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers HTTP/1.1
Host: northwind.netcore.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAllCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel" />
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel.Types"> <d2p1:Customer> <d2p1:Address>String</d2p1:Address> <d2p1:City>String</d2p1:City> <d2p1:CompanyName>String</d2p1:CompanyName> <d2p1:ContactName>String</d2p1:ContactName> <d2p1:ContactTitle>String</d2p1:ContactTitle> <d2p1:Country>String</d2p1:Country> <d2p1:Fax>String</d2p1:Fax> <d2p1:Id>String</d2p1:Id> <d2p1:Phone>String</d2p1:Phone> <d2p1:PostalCode>String</d2p1:PostalCode> <d2p1:Region>String</d2p1:Region> </d2p1:Customer> </Results> </CustomersResponse>