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}
SmartsheetsRequest Parameters:
NameParameterData TypeRequiredDescription
AgentIDpathintNo
SheetTypepathstringNo
SmartsheetsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LifeformList<SmartsheetsLife>No
FlowformList<SmartsheetsFlow>No
TransferformList<SmartsheetsTransfer>No
IssuedClosedformList<SmartsheetsIssuedClosed>No
SmartsheetsLife Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
FirstNameformstringNo
LastNameformstringNo
PolicyNumberformstringNo
PolicyTypeformstringNo
CPTformstringNo
AppDateformstringNo
AgentNameformstringNo
AgentIDformint?No
PhaseformstringNo
NotesformstringNo
TransferAmountformstringNo
AccountNumberformstringNo
DeletedformboolNo
ModifiedByformstringNo
FlaggedformboolNo
TransactionIdformstringNo
FaceValueformstringNo
HasChangeformboolNo
HasConversationformboolNo
HasAgentMsgformboolNo
HasAdminMsgformboolNo
AttachmentformList<Attachment>No
ReminderformList<Reminder>No
AgentsformstringNo
HasOCRformboolNo
PolicyAssociateIdformGuidNo
HasRequiredDocumentsformboolNo
PhoneformstringNo
EmailAddressformstringNo
ApprovedDateformstringNo
ApprovedByformstringNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdformGuidNo
TableNameformstringNo
FieldNameformstringNo
RecordIdformintNo
AttachmentNameformstringNo
MimeTypeformstringNo
AttachmentDataformbyte[]No
FileSizeInKBformdoubleNo
CreatedDateformDateTimeNo
CreatedByformstringNo
NeedsOCRformboolNo
OCRDateformDateTimeNo
IsSecuritiesformboolNo
AWSKeyformstringNo
PresignedUrlformstringNo
Reminder Parameters:
NameParameterData TypeRequiredDescription
ReminderIdformGuidNo
TableNameformstringNo
FieldNameformstringNo
RecordIdformintNo
ReminderDateformDateTimeNo
ReminderNoteformstringNo
CreatedDateformDateTimeNo
CreatedByformstringNo
CompletedDateformDateTimeNo
SmartsheetsFlow Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
FirstNameformstringNo
LastNameformstringNo
PolicyNumberformstringNo
PolicyTypeformstringNo
AppDateformstringNo
AgentNameformstringNo
AgentIDformint?No
SRAStartDateformstringNo
PhaseformstringNo
ModalPremiumformstringNo
FrequencyformstringNo
AnnualPremiumformstringNo
DistrictformstringNo
SSformstringNo
CarrierformstringNo
NotesformstringNo
TPAformstringNo
FlaggedformboolNo
DeletedformboolNo
ModifiedByformstringNo
TransactionIdformstringNo
HasChangeformboolNo
HasConversationformboolNo
HasAgentMsgformboolNo
HasAdminMsgformboolNo
AttachmentformList<Attachment>No
ReminderformList<Reminder>No
AgentsformstringNo
HasOCRformboolNo
PolicyAssociateIdformGuidNo
HasRequiredDocumentsformboolNo
PhoneformstringNo
EmailAddressformstringNo
ApprovedDateformstringNo
ApprovedByformstringNo
SmartsheetsTransfer Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
FlaggedformboolNo
PhaseformstringNo
FirstNameformstringNo
LastNameformstringNo
PolicyNumberformstringNo
PolicyTypeformstringNo
AppDateformstringNo
AgentNameformstringNo
AgentIDformint?No
RegionalOfficeformstringNo
TransferAmountformstringNo
TransferringCompanyformstringNo
AccountNumberformstringNo
SSformstringNo
NotesformstringNo
DeletedformboolNo
ModifiedByformstringNo
TransactionIdformstringNo
HasChangeformboolNo
HasConversationformboolNo
HasAgentMsgformboolNo
HasAdminMsgformboolNo
AttachmentformList<Attachment>No
ReminderformList<Reminder>No
AgentsformstringNo
HasOCRformboolNo
PolicyAssociateIdformGuidNo
HasRequiredDocumentsformboolNo
PhoneformstringNo
EmailAddressformstringNo
ApprovedDateformstringNo
ApprovedByformstringNo
SmartsheetsIssuedClosed Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
IDformintNo
FlaggedformboolNo
PhaseformstringNo
FirstNameformstringNo
LastNameformstringNo
PolicyNumberformstringNo
AgentNameformstringNo
NotesformstringNo
DeletedformboolNo
ModifiedByformstringNo
HasChangeformboolNo
HasConversationformboolNo
HasAgentMsgformboolNo
HasAdminMsgformboolNo
AttachmentformList<Attachment>No
ReminderformList<Reminder>No
HasOCRformboolNo
AppDateformstringNo
TransactionIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}],"Reminder":[{"ReminderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"ReminderDate":"0001-01-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}],"Reminder":[{"ReminderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"ReminderDate":"0001-01-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}],"Reminder":[{"ReminderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"ReminderDate":"0001-01-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","CreatedBy":"String","NeedsOCR":false,"OCRDate":"0001-01-01T00:00:00.0000000","IsSecurities":false,"AWSKey":"String","PresignedUrl":"String"}],"Reminder":[{"ReminderId":"00000000000000000000000000000000","TableName":"String","FieldName":"String","RecordId":0,"ReminderDate":"0001-01-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"HasOCR":false,"AppDate":"String","TransactionId":"String"}]}