| GET,POST,PUT,OPTIONS | /v1/BusinessCard |
|---|
"use strict";
export class Address {
/** @param {{ID?:number,AddressTypeID?:number,AddressContact?:string,AttentionTo?:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,AddressCity?:string,AddressState?:string,AddressZip?:string,AddressCountry?:string,PhoneNumber?:string,FaxNumber?:string,UID?:string,Name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ID;
/** @type {number} */
AddressTypeID;
/** @type {string} */
AddressContact;
/** @type {string} */
AttentionTo;
/** @type {string} */
AddressLine1;
/** @type {string} */
AddressLine2;
/** @type {string} */
AddressLine3;
/** @type {string} */
AddressCity;
/** @type {string} */
AddressState;
/** @type {string} */
AddressZip;
/** @type {string} */
AddressCountry;
/** @type {string} */
PhoneNumber;
/** @type {string} */
FaxNumber;
/** @type {string} */
UID;
/** @type {string} */
Name;
}
export class BusinessCard {
/** @param {{CardId?:number,AgentId?:number,NumRows?:number,Name?:string,Title?:string,Phone?:string,Fax?:string,Cell?:string,Email?:string,Address?:string,License?:string,SubmittedDate?:string,OrderedDate?:string,ProofApprovedDate?:string,AdminApproved?:string,AdminApprovedDate?:string,Quantity?:number,Notes?:string,ShippingAddressId?:number,BusinessCardFrontTypeId?:number,BusinessCardBackTypeId?:number,ArtURL?:string,OrderedURL?:string,OrderedAddress?:Address,OrderedUser?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CardId;
/** @type {number} */
AgentId;
/** @type {number} */
NumRows;
/** @type {string} */
Name;
/** @type {string} */
Title;
/** @type {string} */
Phone;
/** @type {string} */
Fax;
/** @type {string} */
Cell;
/** @type {string} */
Email;
/** @type {string} */
Address;
/** @type {string} */
License;
/** @type {?string} */
SubmittedDate;
/** @type {?string} */
OrderedDate;
/** @type {?string} */
ProofApprovedDate;
/** @type {string} */
AdminApproved;
/** @type {?string} */
AdminApprovedDate;
/** @type {number} */
Quantity;
/** @type {string} */
Notes;
/** @type {number} */
ShippingAddressId;
/** @type {number} */
BusinessCardFrontTypeId;
/** @type {number} */
BusinessCardBackTypeId;
/** @type {string} */
ArtURL;
/** @type {string} */
OrderedURL;
/** @type {Address} */
OrderedAddress;
/** @type {string} */
OrderedUser;
}
export class BusinessCardResponse {
/** @param {{ResponseStatus?:ResponseStatus,BusinessCard?:BusinessCard[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {BusinessCard[]} */
BusinessCard = [];
}
export class BusinessCardRequest {
/** @param {{BusinessCard?:BusinessCard[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BusinessCard[]} */
BusinessCard = [];
}
JavaScript BusinessCardRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/BusinessCard HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BusinessCard:
[
{
CardId: 0,
AgentId: 0,
NumRows: 0,
Name: String,
Title: String,
Phone: String,
Fax: String,
Cell: String,
Email: String,
Address: String,
License: String,
SubmittedDate: 0001-01-01,
OrderedDate: 0001-01-01,
ProofApprovedDate: 0001-01-01,
AdminApproved: String,
AdminApprovedDate: 0001-01-01,
Quantity: 0,
Notes: String,
ShippingAddressId: 0,
BusinessCardFrontTypeId: 0,
BusinessCardBackTypeId: 0,
ArtURL: String,
OrderedURL: String,
OrderedAddress:
{
ID: 0,
AddressTypeID: 0,
AddressContact: String,
AttentionTo: String,
AddressLine1: String,
AddressLine2: String,
AddressLine3: String,
AddressCity: String,
AddressState: String,
AddressZip: String,
AddressCountry: String,
PhoneNumber: String,
FaxNumber: String,
UID: 00000000000000000000000000000000,
Name: String
},
OrderedUser: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BusinessCard:
[
{
CardId: 0,
AgentId: 0,
NumRows: 0,
Name: String,
Title: String,
Phone: String,
Fax: String,
Cell: String,
Email: String,
Address: String,
License: String,
SubmittedDate: 0001-01-01,
OrderedDate: 0001-01-01,
ProofApprovedDate: 0001-01-01,
AdminApproved: String,
AdminApprovedDate: 0001-01-01,
Quantity: 0,
Notes: String,
ShippingAddressId: 0,
BusinessCardFrontTypeId: 0,
BusinessCardBackTypeId: 0,
ArtURL: String,
OrderedURL: String,
OrderedAddress:
{
ID: 0,
AddressTypeID: 0,
AddressContact: String,
AttentionTo: String,
AddressLine1: String,
AddressLine2: String,
AddressLine3: String,
AddressCity: String,
AddressState: String,
AddressZip: String,
AddressCountry: String,
PhoneNumber: String,
FaxNumber: String,
UID: 00000000000000000000000000000000,
Name: String
},
OrderedUser: String
}
]
}