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}

export class Attachment
{
    public AttachmentId: string;
    public TableName: string;
    public FieldName: string;
    public RecordId: number;
    public AttachmentName: string;
    public MimeType: string;
    public AttachmentData: string = [];
    public FileSizeInKB: number;
    public CreatedDate: string;
    public CreatedBy: string;
    public NeedsOCR: boolean;
    public OCRDate: string;
    public IsSecurities: boolean;
    public AWSKey: string;
    public PresignedUrl: string;

    public constructor(init?: Partial<Attachment>) { (Object as any).assign(this, init); }
}

export class Reminder
{
    public ReminderId: string;
    public TableName: string;
    public FieldName: string;
    public RecordId: number;
    public ReminderDate: string;
    public ReminderNote: string;
    public CreatedDate: string;
    public CreatedBy: string;
    public CompletedDate: string;

    public constructor(init?: Partial<Reminder>) { (Object as any).assign(this, init); }
}

export class SmartsheetsLife
{
    public ID: number;
    public FirstName: string;
    public LastName: string;
    public PolicyNumber: string;
    public PolicyType: string;
    public CPT: string;
    public AppDate: string;
    public AgentName: string;
    public AgentID?: number;
    public Phase: string;
    public Notes: string;
    public TransferAmount: string;
    public AccountNumber: string;
    public Deleted: boolean;
    public ModifiedBy: string;
    public Flagged: boolean;
    public TransactionId: string;
    public FaceValue: string;
    public HasChange: boolean;
    public HasConversation: boolean;
    public HasAgentMsg: boolean;
    public HasAdminMsg: boolean;
    public Attachment: Attachment[] = [];
    public Reminder: Reminder[] = [];
    public Agents: string;
    public HasOCR: boolean;
    public PolicyAssociateId: string;
    public HasRequiredDocuments: boolean;
    public Phone: string;
    public EmailAddress: string;
    public ApprovedDate: string;
    public ApprovedBy: string;

    public constructor(init?: Partial<SmartsheetsLife>) { (Object as any).assign(this, init); }
}

export class SmartsheetsFlow
{
    public ID: number;
    public FirstName: string;
    public LastName: string;
    public PolicyNumber: string;
    public PolicyType: string;
    public AppDate: string;
    public AgentName: string;
    public AgentID?: number;
    public SRAStartDate: string;
    public Phase: string;
    public ModalPremium: string;
    public Frequency: string;
    public AnnualPremium: string;
    public District: string;
    public SS: string;
    public Carrier: string;
    public Notes: string;
    public TPA: string;
    public Flagged: boolean;
    public Deleted: boolean;
    public ModifiedBy: string;
    public TransactionId: string;
    public HasChange: boolean;
    public HasConversation: boolean;
    public HasAgentMsg: boolean;
    public HasAdminMsg: boolean;
    public Attachment: Attachment[] = [];
    public Reminder: Reminder[] = [];
    public Agents: string;
    public HasOCR: boolean;
    public PolicyAssociateId: string;
    public HasRequiredDocuments: boolean;
    public Phone: string;
    public EmailAddress: string;
    public ApprovedDate: string;
    public ApprovedBy: string;

    public constructor(init?: Partial<SmartsheetsFlow>) { (Object as any).assign(this, init); }
}

export class SmartsheetsTransfer
{
    public ID: number;
    public Flagged: boolean;
    public Phase: string;
    public FirstName: string;
    public LastName: string;
    public PolicyNumber: string;
    public PolicyType: string;
    public AppDate: string;
    public AgentName: string;
    public AgentID?: number;
    public RegionalOffice: string;
    public TransferAmount: string;
    public TransferringCompany: string;
    public AccountNumber: string;
    public SS: string;
    public Notes: string;
    public Deleted: boolean;
    public ModifiedBy: string;
    public TransactionId: string;
    public HasChange: boolean;
    public HasConversation: boolean;
    public HasAgentMsg: boolean;
    public HasAdminMsg: boolean;
    public Attachment: Attachment[] = [];
    public Reminder: Reminder[] = [];
    public Agents: string;
    public HasOCR: boolean;
    public PolicyAssociateId: string;
    public HasRequiredDocuments: boolean;
    public Phone: string;
    public EmailAddress: string;
    public ApprovedDate: string;
    public ApprovedBy: string;

    public constructor(init?: Partial<SmartsheetsTransfer>) { (Object as any).assign(this, init); }
}

export class SmartsheetsIssuedClosed
{
    public Type: string;
    public ID: number;
    public Flagged: boolean;
    public Phase: string;
    public FirstName: string;
    public LastName: string;
    public PolicyNumber: string;
    public AgentName: string;
    public Notes: string;
    public Deleted: boolean;
    public ModifiedBy: string;
    public HasChange: boolean;
    public HasConversation: boolean;
    public HasAgentMsg: boolean;
    public HasAdminMsg: boolean;
    public Attachment: Attachment[] = [];
    public Reminder: Reminder[] = [];
    public HasOCR: boolean;
    public AppDate: string;
    public TransactionId: string;

    public constructor(init?: Partial<SmartsheetsIssuedClosed>) { (Object as any).assign(this, init); }
}

export class SmartsheetsResponse
{
    public ResponseStatus: ResponseStatus;
    public Life: SmartsheetsLife[] = [];
    public Flow: SmartsheetsFlow[] = [];
    public Transfer: SmartsheetsTransfer[] = [];
    public IssuedClosed: SmartsheetsIssuedClosed[] = [];

    public constructor(init?: Partial<SmartsheetsResponse>) { (Object as any).assign(this, init); }
}

export class SmartsheetsRequest
{
    public AgentID: number;
    public SheetType: string;

    public constructor(init?: Partial<SmartsheetsRequest>) { (Object as any).assign(this, init); }
}

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