Trendsic Platform Service

<back to all web services

BusinessCardAdminRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/BusinessCardAdmin
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    id: int = 0
    address_type_i_d: int = 0
    address_contact: Optional[str] = None
    attention_to: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_city: Optional[str] = None
    address_state: Optional[str] = None
    address_zip: Optional[str] = None
    address_country: Optional[str] = None
    phone_number: Optional[str] = None
    fax_number: Optional[str] = None
    uid: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessCard:
    card_id: int = 0
    agent_id: int = 0
    num_rows: int = 0
    name: Optional[str] = None
    title: Optional[str] = None
    phone: Optional[str] = None
    fax: Optional[str] = None
    cell: Optional[str] = None
    email: Optional[str] = None
    address: Optional[str] = None
    license: Optional[str] = None
    submitted_date: Optional[datetime.datetime] = None
    ordered_date: Optional[datetime.datetime] = None
    proof_approved_date: Optional[datetime.datetime] = None
    admin_approved: Optional[str] = None
    admin_approved_date: Optional[datetime.datetime] = None
    quantity: int = 0
    notes: Optional[str] = None
    shipping_address_id: int = 0
    business_card_front_type_id: int = 0
    business_card_back_type_id: int = 0
    art_u_r_l: Optional[str] = None
    ordered_u_r_l: Optional[str] = None
    ordered_address: Optional[Address] = None
    ordered_user: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessCardResponse:
    response_status: Optional[ResponseStatus] = None
    business_card: List[BusinessCard] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessCardAdminRequest:
    business_card: List[BusinessCard] = field(default_factory=list)

Python BusinessCardAdminRequest 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.

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
		}
	]
}