Trendsic Platform Service

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}

**SmartsheetsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AgentID	path	int	No
SheetType	path	string	No

**SmartsheetsResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Life	form	List<SmartsheetsLife>	No
Flow	form	List<SmartsheetsFlow>	No
Transfer	form	List<SmartsheetsTransfer>	No
IssuedClosed	form	List<SmartsheetsIssuedClosed>	No

**SmartsheetsLife** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
FirstName	form	string	No
LastName	form	string	No
PolicyNumber	form	string	No
PolicyType	form	string	No
CPT	form	string	No
AppDate	form	string	No
AgentName	form	string	No
AgentID	form	int?	No
Phase	form	string	No
Notes	form	string	No
TransferAmount	form	string	No
AccountNumber	form	string	No
Deleted	form	bool	No
ModifiedBy	form	string	No
Flagged	form	bool	No
TransactionId	form	string	No
FaceValue	form	string	No
HasChange	form	bool	No
HasConversation	form	bool	No
HasAgentMsg	form	bool	No
HasAdminMsg	form	bool	No
Attachment	form	List<Attachment>	No
Reminder	form	List<Reminder>	No
Agents	form	string	No
HasOCR	form	bool	No
PolicyAssociateId	form	Guid	No
HasRequiredDocuments	form	bool	No
Phone	form	string	No
EmailAddress	form	string	No
ApprovedDate	form	string	No
ApprovedBy	form	string	No

**Attachment** Parameters:
Name	Parameter	Data Type	Required
AttachmentId	form	Guid	No
TableName	form	string	No
FieldName	form	string	No
RecordId	form	int	No
AttachmentName	form	string	No
MimeType	form	string	No
AttachmentData	form	byte[]	No
FileSizeInKB	form	double	No
CreatedDate	form	DateTime	No
CreatedBy	form	string	No
NeedsOCR	form	bool	No
OCRDate	form	DateTime	No
IsSecurities	form	bool	No
AWSKey	form	string	No
PresignedUrl	form	string	No

**Reminder** Parameters:
Name	Parameter	Data Type	Required
ReminderId	form	Guid	No
TableName	form	string	No
FieldName	form	string	No
RecordId	form	int	No
ReminderDate	form	DateTime	No
ReminderNote	form	string	No
CreatedDate	form	DateTime	No
CreatedBy	form	string	No
CompletedDate	form	DateTime	No

**SmartsheetsFlow** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
FirstName	form	string	No
LastName	form	string	No
PolicyNumber	form	string	No
PolicyType	form	string	No
AppDate	form	string	No
AgentName	form	string	No
AgentID	form	int?	No
SRAStartDate	form	string	No
Phase	form	string	No
ModalPremium	form	string	No
Frequency	form	string	No
AnnualPremium	form	string	No
District	form	string	No
SS	form	string	No
Carrier	form	string	No
Notes	form	string	No
TPA	form	string	No
Flagged	form	bool	No
Deleted	form	bool	No
ModifiedBy	form	string	No
TransactionId	form	string	No
HasChange	form	bool	No
HasConversation	form	bool	No
HasAgentMsg	form	bool	No
HasAdminMsg	form	bool	No
Attachment	form	List<Attachment>	No
Reminder	form	List<Reminder>	No
Agents	form	string	No
HasOCR	form	bool	No
PolicyAssociateId	form	Guid	No
HasRequiredDocuments	form	bool	No
Phone	form	string	No
EmailAddress	form	string	No
ApprovedDate	form	string	No
ApprovedBy	form	string	No

**SmartsheetsTransfer** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Flagged	form	bool	No
Phase	form	string	No
FirstName	form	string	No
LastName	form	string	No
PolicyNumber	form	string	No
PolicyType	form	string	No
AppDate	form	string	No
AgentName	form	string	No
AgentID	form	int?	No
RegionalOffice	form	string	No
TransferAmount	form	string	No
TransferringCompany	form	string	No
AccountNumber	form	string	No
SS	form	string	No
Notes	form	string	No
Deleted	form	bool	No
ModifiedBy	form	string	No
TransactionId	form	string	No
HasChange	form	bool	No
HasConversation	form	bool	No
HasAgentMsg	form	bool	No
HasAdminMsg	form	bool	No
Attachment	form	List<Attachment>	No
Reminder	form	List<Reminder>	No
Agents	form	string	No
HasOCR	form	bool	No
PolicyAssociateId	form	Guid	No
HasRequiredDocuments	form	bool	No
Phone	form	string	No
EmailAddress	form	string	No
ApprovedDate	form	string	No
ApprovedBy	form	string	No

**SmartsheetsIssuedClosed** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
ID	form	int	No
Flagged	form	bool	No
Phase	form	string	No
FirstName	form	string	No
LastName	form	string	No
PolicyNumber	form	string	No
AgentName	form	string	No
Notes	form	string	No
Deleted	form	bool	No
ModifiedBy	form	string	No
HasChange	form	bool	No
HasConversation	form	bool	No
HasAgentMsg	form	bool	No
HasAdminMsg	form	bool	No
Attachment	form	List<Attachment>	No
Reminder	form	List<Reminder>	No
HasOCR	form	bool	No
AppDate	form	string	No
TransactionId	form	string	No

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