Trendsic Platform Service

<back to all web services

BusinessCardRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/BusinessCard
import Foundation
import ServiceStack

public class BusinessCardRequest : Codable
{
    public var businessCard:[BusinessCard] = []

    required public init(){}
}

public class BusinessCard : Codable
{
    public var cardId:Int
    public var agentId:Int
    public var numRows:Int16
    public var name:String
    public var title:String
    public var phone:String
    public var fax:String
    public var cell:String
    public var email:String
    public var address:String
    public var license:String
    public var submittedDate:Date?
    public var orderedDate:Date?
    public var proofApprovedDate:Date?
    public var adminApproved:String
    public var adminApprovedDate:Date?
    public var quantity:Int
    public var notes:String
    public var shippingAddressId:Int
    public var businessCardFrontTypeId:Int
    public var businessCardBackTypeId:Int
    public var artURL:String
    public var orderedURL:String
    public var orderedAddress:Address
    public var orderedUser:String

    required public init(){}
}

public class Address : Codable
{
    public var id:Int
    public var addressTypeID:UInt8
    public var addressContact:String
    public var attentionTo:String
    public var addressLine1:String
    public var addressLine2:String
    public var addressLine3:String
    public var addressCity:String
    public var addressState:String
    public var addressZip:String
    public var addressCountry:String
    public var phoneNumber:String
    public var faxNumber:String
    public var uid:String
    public var name:String

    required public init(){}
}

public class BusinessCardResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var businessCard:[BusinessCard] = []

    required public init(){}
}


Swift BusinessCardRequest 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 /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
		}
	]
}