Trendsic Platform Service

<back to all web services

SmartsheetsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Smartsheets/{AgentID}
GET/v1/Smartsheets
GET/v1/Smartsheets/{AgentID}/{SheetType}
import Foundation
import ServiceStack

public class SmartsheetsRequest : Codable
{
    public var agentID:Int
    public var sheetType:String

    required public init(){}
}

public class SmartsheetsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var life:[SmartsheetsLife] = []
    public var flow:[SmartsheetsFlow] = []
    public var transfer:[SmartsheetsTransfer] = []
    public var issuedClosed:[SmartsheetsIssuedClosed] = []

    required public init(){}
}

public class SmartsheetsLife : Codable
{
    public var id:Int
    public var firstName:String
    public var lastName:String
    public var policyNumber:String
    public var policyType:String
    public var cpt:String
    public var appDate:String
    public var agentName:String
    public var agentID:Int?
    public var phase:String
    public var notes:String
    public var transferAmount:String
    public var accountNumber:String
    public var deleted:Bool
    public var modifiedBy:String
    public var flagged:Bool
    public var transactionId:String
    public var faceValue:String
    public var hasChange:Bool
    public var hasConversation:Bool
    public var hasAgentMsg:Bool
    public var hasAdminMsg:Bool
    public var attachment:[Attachment] = []
    public var reminder:[Reminder] = []
    public var agents:String
    public var hasOCR:Bool
    public var policyAssociateId:String
    public var hasRequiredDocuments:Bool
    public var phone:String
    public var emailAddress:String
    public var approvedDate:String
    public var approvedBy:String

    required public init(){}
}

public class Attachment : Codable
{
    public var attachmentId:String
    public var tableName:String
    public var fieldName:String
    public var recordId:Int
    public var attachmentName:String
    public var mimeType:String
    public var attachmentData:[UInt8] = []
    public var fileSizeInKB:Double
    public var createdDate:Date
    public var createdBy:String
    public var needsOCR:Bool
    public var ocrDate:Date
    public var isSecurities:Bool
    public var awsKey:String
    public var presignedUrl:String

    required public init(){}
}

public class Reminder : Codable
{
    public var reminderId:String
    public var tableName:String
    public var fieldName:String
    public var recordId:Int
    public var reminderDate:Date
    public var reminderNote:String
    public var createdDate:Date
    public var createdBy:String
    public var completedDate:Date

    required public init(){}
}

public class SmartsheetsFlow : Codable
{
    public var id:Int
    public var firstName:String
    public var lastName:String
    public var policyNumber:String
    public var policyType:String
    public var appDate:String
    public var agentName:String
    public var agentID:Int?
    public var sraStartDate:String
    public var phase:String
    public var modalPremium:String
    public var frequency:String
    public var annualPremium:String
    public var district:String
    public var ss:String
    public var carrier:String
    public var notes:String
    public var tpa:String
    public var flagged:Bool
    public var deleted:Bool
    public var modifiedBy:String
    public var transactionId:String
    public var hasChange:Bool
    public var hasConversation:Bool
    public var hasAgentMsg:Bool
    public var hasAdminMsg:Bool
    public var attachment:[Attachment] = []
    public var reminder:[Reminder] = []
    public var agents:String
    public var hasOCR:Bool
    public var policyAssociateId:String
    public var hasRequiredDocuments:Bool
    public var phone:String
    public var emailAddress:String
    public var approvedDate:String
    public var approvedBy:String

    required public init(){}
}

public class SmartsheetsTransfer : Codable
{
    public var id:Int
    public var flagged:Bool
    public var phase:String
    public var firstName:String
    public var lastName:String
    public var policyNumber:String
    public var policyType:String
    public var appDate:String
    public var agentName:String
    public var agentID:Int?
    public var regionalOffice:String
    public var transferAmount:String
    public var transferringCompany:String
    public var accountNumber:String
    public var ss:String
    public var notes:String
    public var deleted:Bool
    public var modifiedBy:String
    public var transactionId:String
    public var hasChange:Bool
    public var hasConversation:Bool
    public var hasAgentMsg:Bool
    public var hasAdminMsg:Bool
    public var attachment:[Attachment] = []
    public var reminder:[Reminder] = []
    public var agents:String
    public var hasOCR:Bool
    public var policyAssociateId:String
    public var hasRequiredDocuments:Bool
    public var phone:String
    public var emailAddress:String
    public var approvedDate:String
    public var approvedBy:String

    required public init(){}
}

public class SmartsheetsIssuedClosed : Codable
{
    public var type:String
    public var id:Int
    public var flagged:Bool
    public var phase:String
    public var firstName:String
    public var lastName:String
    public var policyNumber:String
    public var agentName:String
    public var notes:String
    public var deleted:Bool
    public var modifiedBy:String
    public var hasChange:Bool
    public var hasConversation:Bool
    public var hasAgentMsg:Bool
    public var hasAdminMsg:Bool
    public var attachment:[Attachment] = []
    public var reminder:[Reminder] = []
    public var hasOCR:Bool
    public var appDate:String
    public var transactionId:String

    required public init(){}
}


Swift SmartsheetsRequest 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/Smartsheets/{AgentID} 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
		}
	},
	Life: 
	[
		{
			ID: 0,
			FirstName: String,
			LastName: String,
			PolicyNumber: String,
			PolicyType: String,
			CPT: String,
			AppDate: String,
			AgentName: String,
			AgentID: 0,
			Phase: String,
			Notes: String,
			TransferAmount: String,
			AccountNumber: String,
			Deleted: False,
			ModifiedBy: String,
			Flagged: False,
			TransactionId: String,
			FaceValue: String,
			HasChange: False,
			HasConversation: False,
			HasAgentMsg: False,
			HasAdminMsg: False,
			Attachment: 
			[
				{
					AttachmentId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					AttachmentName: String,
					MimeType: String,
					AttachmentData: AA==,
					FileSizeInKB: 0,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					NeedsOCR: False,
					OCRDate: 0001-01-01,
					IsSecurities: False,
					AWSKey: String,
					PresignedUrl: String
				}
			],
			Reminder: 
			[
				{
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			Agents: String,
			HasOCR: False,
			PolicyAssociateId: 00000000000000000000000000000000,
			HasRequiredDocuments: False,
			Phone: String,
			EmailAddress: String,
			ApprovedDate: String,
			ApprovedBy: String
		}
	],
	Flow: 
	[
		{
			ID: 0,
			FirstName: String,
			LastName: String,
			PolicyNumber: String,
			PolicyType: String,
			AppDate: String,
			AgentName: String,
			AgentID: 0,
			SRAStartDate: String,
			Phase: String,
			ModalPremium: String,
			Frequency: String,
			AnnualPremium: String,
			District: String,
			SS: String,
			Carrier: String,
			Notes: String,
			TPA: String,
			Flagged: False,
			Deleted: False,
			ModifiedBy: String,
			TransactionId: String,
			HasChange: False,
			HasConversation: False,
			HasAgentMsg: False,
			HasAdminMsg: False,
			Attachment: 
			[
				{
					AttachmentId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					AttachmentName: String,
					MimeType: String,
					AttachmentData: AA==,
					FileSizeInKB: 0,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					NeedsOCR: False,
					OCRDate: 0001-01-01,
					IsSecurities: False,
					AWSKey: String,
					PresignedUrl: String
				}
			],
			Reminder: 
			[
				{
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			Agents: String,
			HasOCR: False,
			PolicyAssociateId: 00000000000000000000000000000000,
			HasRequiredDocuments: False,
			Phone: String,
			EmailAddress: String,
			ApprovedDate: String,
			ApprovedBy: String
		}
	],
	Transfer: 
	[
		{
			ID: 0,
			Flagged: False,
			Phase: String,
			FirstName: String,
			LastName: String,
			PolicyNumber: String,
			PolicyType: String,
			AppDate: String,
			AgentName: String,
			AgentID: 0,
			RegionalOffice: String,
			TransferAmount: String,
			TransferringCompany: String,
			AccountNumber: String,
			SS: String,
			Notes: String,
			Deleted: False,
			ModifiedBy: String,
			TransactionId: String,
			HasChange: False,
			HasConversation: False,
			HasAgentMsg: False,
			HasAdminMsg: False,
			Attachment: 
			[
				{
					AttachmentId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					AttachmentName: String,
					MimeType: String,
					AttachmentData: AA==,
					FileSizeInKB: 0,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					NeedsOCR: False,
					OCRDate: 0001-01-01,
					IsSecurities: False,
					AWSKey: String,
					PresignedUrl: String
				}
			],
			Reminder: 
			[
				{
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			Agents: String,
			HasOCR: False,
			PolicyAssociateId: 00000000000000000000000000000000,
			HasRequiredDocuments: False,
			Phone: String,
			EmailAddress: String,
			ApprovedDate: String,
			ApprovedBy: String
		}
	],
	IssuedClosed: 
	[
		{
			Type: String,
			ID: 0,
			Flagged: False,
			Phase: String,
			FirstName: String,
			LastName: String,
			PolicyNumber: String,
			AgentName: String,
			Notes: String,
			Deleted: False,
			ModifiedBy: String,
			HasChange: False,
			HasConversation: False,
			HasAgentMsg: False,
			HasAdminMsg: False,
			Attachment: 
			[
				{
					AttachmentId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					AttachmentName: String,
					MimeType: String,
					AttachmentData: AA==,
					FileSizeInKB: 0,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					NeedsOCR: False,
					OCRDate: 0001-01-01,
					IsSecurities: False,
					AWSKey: String,
					PresignedUrl: String
				}
			],
			Reminder: 
			[
				{
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			HasOCR: False,
			AppDate: String,
			TransactionId: String
		}
	]
}