| GET,OPTIONS | /v1/BusinessCardAdmin |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BusinessCard | query | List<BusinessCard> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardId | form | int | No | |
| AgentId | form | int | No | |
| NumRows | form | short | No | |
| Name | form | string | No | |
| Title | form | string | No | |
| Phone | form | string | No | |
| Fax | form | string | No | |
| Cell | form | string | No | |
| form | string | No | ||
| Address | form | string | No | |
| License | form | string | No | |
| SubmittedDate | form | DateTime? | No | |
| OrderedDate | form | DateTime? | No | |
| ProofApprovedDate | form | DateTime? | No | |
| AdminApproved | form | string | No | |
| AdminApprovedDate | form | DateTime? | No | |
| Quantity | form | int | No | |
| Notes | form | string | No | |
| ShippingAddressId | form | int | No | |
| BusinessCardFrontTypeId | form | int | No | |
| BusinessCardBackTypeId | form | int | No | |
| ArtURL | form | string | No | |
| OrderedURL | form | string | No | |
| OrderedAddress | form | Address | No | |
| OrderedUser | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| AddressTypeID | form | byte | No | |
| AddressContact | form | string | No | |
| AttentionTo | form | string | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressCity | form | string | No | |
| AddressState | form | string | No | |
| AddressZip | form | string | No | |
| AddressCountry | form | string | No | |
| PhoneNumber | form | string | No | |
| FaxNumber | form | string | No | |
| UID | form | Guid | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| BusinessCard | form | List<BusinessCard> | No |
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.
GET /v1/BusinessCardAdmin HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
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
}
]
}