Northwind Web Services

CachedGetOrders

Cached

The following routes are available for this service:
All Verbs	/cached/orders
All Verbs	/cached/orders/page/{Page}
All Verbs	/cached/customers/{CustomerId}/orders


// @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); }
}

// @DataContract
export class OrderDetail
{
    // @DataMember
    public orderId: number;

    // @DataMember
    public productId: number;

    // @DataMember
    public unitPrice: number;

    // @DataMember
    public quantity: number;

    // @DataMember
    public discount: number;

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

// @DataContract
export class CustomerOrder
{
    // @DataMember
    public order: Order;

    // @DataMember
    public orderDetails: OrderDetail[] = [];

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

// @DataContract
export class OrdersResponse
{
    // @DataMember
    public results: CustomerOrder[] = [];

    // @DataMember
    public responseStatus: ResponseStatus;

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

export class CachedGetOrders implements IGet
{
    public page?: number;
    public customerId: string;

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

TypeScript CachedGetOrders DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /cached/orders HTTP/1.1 
Host: uitestapi.occupass.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0,
	customerId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			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
		}
	}
}