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}
"use strict";
export class Attachment {
    /** @param {{AttachmentId?:string,TableName?:string,FieldName?:string,RecordId?:number,AttachmentName?:string,MimeType?:string,AttachmentData?:string,FileSizeInKB?:number,CreatedDate?:string,CreatedBy?:string,NeedsOCR?:boolean,OCRDate?:string,IsSecurities?:boolean,AWSKey?:string,PresignedUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    MimeType;
    /** @type {string} */
    AttachmentData = [];
    /** @type {number} */
    FileSizeInKB;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CreatedBy;
    /** @type {boolean} */
    NeedsOCR;
    /** @type {string} */
    OCRDate;
    /** @type {boolean} */
    IsSecurities;
    /** @type {string} */
    AWSKey;
    /** @type {string} */
    PresignedUrl;
}
export class Reminder {
    /** @param {{ReminderId?:string,TableName?:string,FieldName?:string,RecordId?:number,ReminderDate?:string,ReminderNote?:string,CreatedDate?:string,CreatedBy?:string,CompletedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ReminderId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    ReminderDate;
    /** @type {string} */
    ReminderNote;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CompletedDate;
}
export class SmartsheetsLife {
    /** @param {{ID?:number,FirstName?:string,LastName?:string,PolicyNumber?:string,PolicyType?:string,CPT?:string,AppDate?:string,AgentName?:string,AgentID?:number,Phase?:string,Notes?:string,TransferAmount?:string,AccountNumber?:string,Deleted?:boolean,ModifiedBy?:string,Flagged?:boolean,TransactionId?:string,FaceValue?:string,HasChange?:boolean,HasConversation?:boolean,HasAgentMsg?:boolean,HasAdminMsg?:boolean,Attachment?:Attachment[],Reminder?:Reminder[],Agents?:string,HasOCR?:boolean,PolicyAssociateId?:string,HasRequiredDocuments?:boolean,Phone?:string,EmailAddress?:string,ApprovedDate?:string,ApprovedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PolicyNumber;
    /** @type {string} */
    PolicyType;
    /** @type {string} */
    CPT;
    /** @type {string} */
    AppDate;
    /** @type {string} */
    AgentName;
    /** @type {?number} */
    AgentID;
    /** @type {string} */
    Phase;
    /** @type {string} */
    Notes;
    /** @type {string} */
    TransferAmount;
    /** @type {string} */
    AccountNumber;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    ModifiedBy;
    /** @type {boolean} */
    Flagged;
    /** @type {string} */
    TransactionId;
    /** @type {string} */
    FaceValue;
    /** @type {boolean} */
    HasChange;
    /** @type {boolean} */
    HasConversation;
    /** @type {boolean} */
    HasAgentMsg;
    /** @type {boolean} */
    HasAdminMsg;
    /** @type {Attachment[]} */
    Attachment = [];
    /** @type {Reminder[]} */
    Reminder = [];
    /** @type {string} */
    Agents;
    /** @type {boolean} */
    HasOCR;
    /** @type {string} */
    PolicyAssociateId;
    /** @type {boolean} */
    HasRequiredDocuments;
    /** @type {string} */
    Phone;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    ApprovedDate;
    /** @type {string} */
    ApprovedBy;
}
export class SmartsheetsFlow {
    /** @param {{ID?:number,FirstName?:string,LastName?:string,PolicyNumber?:string,PolicyType?:string,AppDate?:string,AgentName?:string,AgentID?:number,SRAStartDate?:string,Phase?:string,ModalPremium?:string,Frequency?:string,AnnualPremium?:string,District?:string,SS?:string,Carrier?:string,Notes?:string,TPA?:string,Flagged?:boolean,Deleted?:boolean,ModifiedBy?:string,TransactionId?:string,HasChange?:boolean,HasConversation?:boolean,HasAgentMsg?:boolean,HasAdminMsg?:boolean,Attachment?:Attachment[],Reminder?:Reminder[],Agents?:string,HasOCR?:boolean,PolicyAssociateId?:string,HasRequiredDocuments?:boolean,Phone?:string,EmailAddress?:string,ApprovedDate?:string,ApprovedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PolicyNumber;
    /** @type {string} */
    PolicyType;
    /** @type {string} */
    AppDate;
    /** @type {string} */
    AgentName;
    /** @type {?number} */
    AgentID;
    /** @type {string} */
    SRAStartDate;
    /** @type {string} */
    Phase;
    /** @type {string} */
    ModalPremium;
    /** @type {string} */
    Frequency;
    /** @type {string} */
    AnnualPremium;
    /** @type {string} */
    District;
    /** @type {string} */
    SS;
    /** @type {string} */
    Carrier;
    /** @type {string} */
    Notes;
    /** @type {string} */
    TPA;
    /** @type {boolean} */
    Flagged;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    ModifiedBy;
    /** @type {string} */
    TransactionId;
    /** @type {boolean} */
    HasChange;
    /** @type {boolean} */
    HasConversation;
    /** @type {boolean} */
    HasAgentMsg;
    /** @type {boolean} */
    HasAdminMsg;
    /** @type {Attachment[]} */
    Attachment = [];
    /** @type {Reminder[]} */
    Reminder = [];
    /** @type {string} */
    Agents;
    /** @type {boolean} */
    HasOCR;
    /** @type {string} */
    PolicyAssociateId;
    /** @type {boolean} */
    HasRequiredDocuments;
    /** @type {string} */
    Phone;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    ApprovedDate;
    /** @type {string} */
    ApprovedBy;
}
export class SmartsheetsTransfer {
    /** @param {{ID?:number,Flagged?:boolean,Phase?:string,FirstName?:string,LastName?:string,PolicyNumber?:string,PolicyType?:string,AppDate?:string,AgentName?:string,AgentID?:number,RegionalOffice?:string,TransferAmount?:string,TransferringCompany?:string,AccountNumber?:string,SS?:string,Notes?:string,Deleted?:boolean,ModifiedBy?:string,TransactionId?:string,HasChange?:boolean,HasConversation?:boolean,HasAgentMsg?:boolean,HasAdminMsg?:boolean,Attachment?:Attachment[],Reminder?:Reminder[],Agents?:string,HasOCR?:boolean,PolicyAssociateId?:string,HasRequiredDocuments?:boolean,Phone?:string,EmailAddress?:string,ApprovedDate?:string,ApprovedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {boolean} */
    Flagged;
    /** @type {string} */
    Phase;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PolicyNumber;
    /** @type {string} */
    PolicyType;
    /** @type {string} */
    AppDate;
    /** @type {string} */
    AgentName;
    /** @type {?number} */
    AgentID;
    /** @type {string} */
    RegionalOffice;
    /** @type {string} */
    TransferAmount;
    /** @type {string} */
    TransferringCompany;
    /** @type {string} */
    AccountNumber;
    /** @type {string} */
    SS;
    /** @type {string} */
    Notes;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    ModifiedBy;
    /** @type {string} */
    TransactionId;
    /** @type {boolean} */
    HasChange;
    /** @type {boolean} */
    HasConversation;
    /** @type {boolean} */
    HasAgentMsg;
    /** @type {boolean} */
    HasAdminMsg;
    /** @type {Attachment[]} */
    Attachment = [];
    /** @type {Reminder[]} */
    Reminder = [];
    /** @type {string} */
    Agents;
    /** @type {boolean} */
    HasOCR;
    /** @type {string} */
    PolicyAssociateId;
    /** @type {boolean} */
    HasRequiredDocuments;
    /** @type {string} */
    Phone;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    ApprovedDate;
    /** @type {string} */
    ApprovedBy;
}
export class SmartsheetsIssuedClosed {
    /** @param {{Type?:string,ID?:number,Flagged?:boolean,Phase?:string,FirstName?:string,LastName?:string,PolicyNumber?:string,AgentName?:string,Notes?:string,Deleted?:boolean,ModifiedBy?:string,HasChange?:boolean,HasConversation?:boolean,HasAgentMsg?:boolean,HasAdminMsg?:boolean,Attachment?:Attachment[],Reminder?:Reminder[],HasOCR?:boolean,AppDate?:string,TransactionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Type;
    /** @type {number} */
    ID;
    /** @type {boolean} */
    Flagged;
    /** @type {string} */
    Phase;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PolicyNumber;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    Notes;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    ModifiedBy;
    /** @type {boolean} */
    HasChange;
    /** @type {boolean} */
    HasConversation;
    /** @type {boolean} */
    HasAgentMsg;
    /** @type {boolean} */
    HasAdminMsg;
    /** @type {Attachment[]} */
    Attachment = [];
    /** @type {Reminder[]} */
    Reminder = [];
    /** @type {boolean} */
    HasOCR;
    /** @type {string} */
    AppDate;
    /** @type {string} */
    TransactionId;
}
export class SmartsheetsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Life?:SmartsheetsLife[],Flow?:SmartsheetsFlow[],Transfer?:SmartsheetsTransfer[],IssuedClosed?:SmartsheetsIssuedClosed[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SmartsheetsLife[]} */
    Life = [];
    /** @type {SmartsheetsFlow[]} */
    Flow = [];
    /** @type {SmartsheetsTransfer[]} */
    Transfer = [];
    /** @type {SmartsheetsIssuedClosed[]} */
    IssuedClosed = [];
}
export class SmartsheetsRequest {
    /** @param {{AgentID?:number,SheetType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentID;
    /** @type {string} */
    SheetType;
}

JavaScript SmartsheetsRequest DTOs

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