| GET | /invoices | ||
|---|---|---|---|
| GET | /invoices/{InvoiceId} |
"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 Invoices {
/** @param {{invoiceId?:number,customerId?:number,invoiceDate?:string,total?:number,billingAddress?:string,billingCity?:string,billingState?:string,billingCountry?:string,billingPostalCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
invoiceId;
/** @type {number} */
customerId;
/** @type {string} */
invoiceDate;
/** @type {number} */
total;
/** @type {string} */
billingAddress;
/** @type {string} */
billingCity;
/** @type {string} */
billingState;
/** @type {string} */
billingCountry;
/** @type {string} */
billingPostalCode;
}
export class QueryInvoices extends QueryDb {
/** @param {{invoiceId?: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} */
invoiceId;
}
export class Albums {
/** @param {{albumId?:number,title?:string,artistId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
albumId;
/** @type {string} */
title;
/** @type {number} */
artistId;
}
/** @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;
}
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 /invoices HTTP/1.1 Host: chinook.netcore.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfInvoicesERq9_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:Invoices>
<d2p1:BillingAddress>String</d2p1:BillingAddress>
<d2p1:BillingCity>String</d2p1:BillingCity>
<d2p1:BillingCountry>String</d2p1:BillingCountry>
<d2p1:BillingPostalCode>String</d2p1:BillingPostalCode>
<d2p1:BillingState>String</d2p1:BillingState>
<d2p1:CustomerId>0</d2p1:CustomerId>
<d2p1:InvoiceDate>0001-01-01T00:00:00</d2p1:InvoiceDate>
<d2p1:InvoiceId>0</d2p1:InvoiceId>
<d2p1:Total>0</d2p1:Total>
</d2p1:Invoices>
</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>
</QueryResponseOfInvoicesERq9_SyN2>