Northwind Web Services

<back to all web services

QueryOrders

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public skip?: number;

    // @DataMember(Order=2)
    public take?: number;

    // @DataMember(Order=3)
    public orderBy: string;

    // @DataMember(Order=4)
    public orderByDesc: string;

    // @DataMember(Order=5)
    public include: string;

    // @DataMember(Order=6)
    public fields: string;

    // @DataMember(Order=7)
    public meta: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class Order
{
    // @DataMember
    public id: number;

    // @DataMember
    public customerId: string;

    // @DataMember
    public employeeId: number;

    // @DataMember
    public orderDate?: string;

    // @DataMember
    public requiredDate?: string;

    // @DataMember
    public shippedDate?: string;

    // @DataMember
    public shipVia?: number;

    // @DataMember
    public freight: number;

    // @DataMember
    public shipName: string;

    // @DataMember
    public shipAddress: string;

    // @DataMember
    public shipCity: string;

    // @DataMember
    public shipRegion: string;

    // @DataMember
    public shipPostalCode: string;

    // @DataMember
    public shipCountry: string;

    public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}

export class QueryOrders extends QueryDb<Order>
{
    public freight?: number;

    public constructor(init?: Partial<QueryOrders>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class Customer
{
    // @DataMember
    public id: string;

    // @DataMember
    public companyName: string;

    // @DataMember
    public contactName: string;

    // @DataMember
    public contactTitle: string;

    // @DataMember
    public address: string;

    // @DataMember
    public city: string;

    // @DataMember
    public region: string;

    // @DataMember
    public postalCode: string;

    // @DataMember
    public country: string;

    // @DataMember
    public phone: string;

    // @DataMember
    public fax: string;

    public constructor(init?: Partial<Customer>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public offset: number;

    // @DataMember(Order=2)
    public total: number;

    // @DataMember(Order=3)
    public results: Customer[];

    // @DataMember(Order=4)
    public meta: { [index:string]: string; };

    // @DataMember(Order=5)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript QueryOrders DTOs

POST /query/orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <Freight>0</Freight>
</QueryOrders>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfOrderhtFHNyBe 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/Northwind.ServiceModel.Types">
    <d2p1:Order>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:EmployeeId>0</d2p1:EmployeeId>
      <d2p1:Freight>0</d2p1:Freight>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
      <d2p1:RequiredDate>0001-01-01T00:00:00</d2p1:RequiredDate>
      <d2p1:ShipAddress>String</d2p1:ShipAddress>
      <d2p1:ShipCity>String</d2p1:ShipCity>
      <d2p1:ShipCountry>String</d2p1:ShipCountry>
      <d2p1:ShipName>String</d2p1:ShipName>
      <d2p1:ShipPostalCode>String</d2p1:ShipPostalCode>
      <d2p1:ShipRegion>String</d2p1:ShipRegion>
      <d2p1:ShipVia>0</d2p1:ShipVia>
      <d2p1:ShippedDate>0001-01-01T00:00:00</d2p1:ShippedDate>
    </d2p1:Order>
  </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>
</QueryResponseOfOrderhtFHNyBe>