GET | /employees | ||
---|---|---|---|
GET | /employees/{EmployeeId} |
"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 Employees {
/** @param {{employeeId?:number,lastName?:string,firstName?:string,title?:string,reportsTo?:number,birthDate?:string,hireDate?:string,address?:string,city?:string,state?:string,country?:string,postalCode?:string,phone?:string,fax?:string,email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
employeeId;
/** @type {string} */
lastName;
/** @type {string} */
firstName;
/** @type {string} */
title;
/** @type {?number} */
reportsTo;
/** @type {?string} */
birthDate;
/** @type {?string} */
hireDate;
/** @type {string} */
address;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
postalCode;
/** @type {string} */
phone;
/** @type {string} */
fax;
/** @type {string} */
email;
}
export class QueryChinookEmployees extends QueryDb {
/** @param {{employeeId?:number,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 {?number} */
employeeId;
}
export class Todo {
/** @param {{id?:number,text?:string,isFinished?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
text;
/** @type {boolean} */
isFinished;
}
/** @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 QueryChinookEmployees 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.
GET /employees HTTP/1.1 Host: blazor-gallery.servicestack.net Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfEmployeesERq9_SyN2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Chinook.ServiceModel.Types"> <d2p1:Employees> <d2p1:Address>String</d2p1:Address> <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate> <d2p1:City>String</d2p1:City> <d2p1:Country>String</d2p1:Country> <d2p1:Email>String</d2p1:Email> <d2p1:EmployeeId>0</d2p1:EmployeeId> <d2p1:Fax>String</d2p1:Fax> <d2p1:FirstName>String</d2p1:FirstName> <d2p1:HireDate>0001-01-01T00:00:00</d2p1:HireDate> <d2p1:LastName>String</d2p1:LastName> <d2p1:Phone>String</d2p1:Phone> <d2p1:PostalCode>String</d2p1:PostalCode> <d2p1:ReportsTo>0</d2p1:ReportsTo> <d2p1:State>String</d2p1:State> <d2p1:Title>String</d2p1:Title> </d2p1:Employees> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <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> </Meta> </ResponseError> </Errors> <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> </Meta> </ResponseStatus> </QueryResponseOfEmployeesERq9_SyN2>