All Verbs | /customers/{Id} |
---|
// @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 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 CustomerDetailsResponse
{
// @DataMember
public customer: Customer;
// @DataMember
public orders: CustomerOrder[];
// @DataMember
public responseStatus: ResponseStatus;
public constructor(init?: Partial<CustomerDetailsResponse>) { (Object as any).assign(this, init); }
}
export class GetCustomerDetails implements IGet
{
public id: string;
public constructor(init?: Partial<GetCustomerDetails>) { (Object as any).assign(this, init); }
}
TypeScript GetCustomerDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{Id} HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"id":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"customer":{"id":"String","companyName":"String","contactName":"String","contactTitle":"String","address":"String","city":"String","region":"String","postalCode":"String","country":"String","phone":"String","fax":"String"},"orders":[{"order":{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","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"}}}