| Requires any of the roles: | Worker, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SmartsheetsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Flow>
<SmartsheetsFlow>
<AgentID>0</AgentID>
<AgentName>String</AgentName>
<Agents>String</Agents>
<AnnualPremium>String</AnnualPremium>
<AppDate>String</AppDate>
<ApprovedBy>String</ApprovedBy>
<ApprovedDate>String</ApprovedDate>
<Attachment>
<Attachment>
<AWSKey>String</AWSKey>
<AttachmentData>AA==</AttachmentData>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AttachmentName>String</AttachmentName>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<FileSizeInKB>0</FileSizeInKB>
<IsSecurities>false</IsSecurities>
<MimeType>String</MimeType>
<NeedsOCR>false</NeedsOCR>
<OCRDate>0001-01-01T00:00:00</OCRDate>
<PresignedUrl>String</PresignedUrl>
<RecordId>0</RecordId>
<TableName>String</TableName>
</Attachment>
</Attachment>
<Carrier>String</Carrier>
<Deleted>false</Deleted>
<District>String</District>
<EmailAddress>String</EmailAddress>
<FirstName>String</FirstName>
<Flagged>false</Flagged>
<Frequency>String</Frequency>
<HasAdminMsg>false</HasAdminMsg>
<HasAgentMsg>false</HasAgentMsg>
<HasChange>false</HasChange>
<HasConversation>false</HasConversation>
<HasOCR>false</HasOCR>
<HasRequiredDocuments>false</HasRequiredDocuments>
<ID>0</ID>
<LastName>String</LastName>
<ModalPremium>String</ModalPremium>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<Phase>String</Phase>
<Phone>String</Phone>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyNumber>String</PolicyNumber>
<PolicyType>String</PolicyType>
<Reminder>
<Reminder>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
</Reminder>
</Reminder>
<SRAStartDate>String</SRAStartDate>
<SS>String</SS>
<TPA>String</TPA>
<TransactionId>String</TransactionId>
</SmartsheetsFlow>
</Flow>
<IssuedClosed>
<SmartsheetsIssuedClosed>
<AgentName>String</AgentName>
<AppDate>String</AppDate>
<Attachment>
<Attachment>
<AWSKey>String</AWSKey>
<AttachmentData>AA==</AttachmentData>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AttachmentName>String</AttachmentName>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<FileSizeInKB>0</FileSizeInKB>
<IsSecurities>false</IsSecurities>
<MimeType>String</MimeType>
<NeedsOCR>false</NeedsOCR>
<OCRDate>0001-01-01T00:00:00</OCRDate>
<PresignedUrl>String</PresignedUrl>
<RecordId>0</RecordId>
<TableName>String</TableName>
</Attachment>
</Attachment>
<Deleted>false</Deleted>
<FirstName>String</FirstName>
<Flagged>false</Flagged>
<HasAdminMsg>false</HasAdminMsg>
<HasAgentMsg>false</HasAgentMsg>
<HasChange>false</HasChange>
<HasConversation>false</HasConversation>
<HasOCR>false</HasOCR>
<ID>0</ID>
<LastName>String</LastName>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<Phase>String</Phase>
<PolicyNumber>String</PolicyNumber>
<Reminder>
<Reminder>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
</Reminder>
</Reminder>
<TransactionId>String</TransactionId>
<Type>String</Type>
</SmartsheetsIssuedClosed>
</IssuedClosed>
<Life>
<SmartsheetsLife>
<AccountNumber>String</AccountNumber>
<AgentID>0</AgentID>
<AgentName>String</AgentName>
<Agents>String</Agents>
<AppDate>String</AppDate>
<ApprovedBy>String</ApprovedBy>
<ApprovedDate>String</ApprovedDate>
<Attachment>
<Attachment>
<AWSKey>String</AWSKey>
<AttachmentData>AA==</AttachmentData>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AttachmentName>String</AttachmentName>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<FileSizeInKB>0</FileSizeInKB>
<IsSecurities>false</IsSecurities>
<MimeType>String</MimeType>
<NeedsOCR>false</NeedsOCR>
<OCRDate>0001-01-01T00:00:00</OCRDate>
<PresignedUrl>String</PresignedUrl>
<RecordId>0</RecordId>
<TableName>String</TableName>
</Attachment>
</Attachment>
<CPT>String</CPT>
<Deleted>false</Deleted>
<EmailAddress>String</EmailAddress>
<FaceValue>String</FaceValue>
<FirstName>String</FirstName>
<Flagged>false</Flagged>
<HasAdminMsg>false</HasAdminMsg>
<HasAgentMsg>false</HasAgentMsg>
<HasChange>false</HasChange>
<HasConversation>false</HasConversation>
<HasOCR>false</HasOCR>
<HasRequiredDocuments>false</HasRequiredDocuments>
<ID>0</ID>
<LastName>String</LastName>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<Phase>String</Phase>
<Phone>String</Phone>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyNumber>String</PolicyNumber>
<PolicyType>String</PolicyType>
<Reminder>
<Reminder>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
</Reminder>
</Reminder>
<TransactionId>String</TransactionId>
<TransferAmount>String</TransferAmount>
</SmartsheetsLife>
</Life>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Transfer>
<SmartsheetsTransfer>
<AccountNumber>String</AccountNumber>
<AgentID>0</AgentID>
<AgentName>String</AgentName>
<Agents>String</Agents>
<AppDate>String</AppDate>
<ApprovedBy>String</ApprovedBy>
<ApprovedDate>String</ApprovedDate>
<Attachment>
<Attachment>
<AWSKey>String</AWSKey>
<AttachmentData>AA==</AttachmentData>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AttachmentName>String</AttachmentName>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<FileSizeInKB>0</FileSizeInKB>
<IsSecurities>false</IsSecurities>
<MimeType>String</MimeType>
<NeedsOCR>false</NeedsOCR>
<OCRDate>0001-01-01T00:00:00</OCRDate>
<PresignedUrl>String</PresignedUrl>
<RecordId>0</RecordId>
<TableName>String</TableName>
</Attachment>
</Attachment>
<Deleted>false</Deleted>
<EmailAddress>String</EmailAddress>
<FirstName>String</FirstName>
<Flagged>false</Flagged>
<HasAdminMsg>false</HasAdminMsg>
<HasAgentMsg>false</HasAgentMsg>
<HasChange>false</HasChange>
<HasConversation>false</HasConversation>
<HasOCR>false</HasOCR>
<HasRequiredDocuments>false</HasRequiredDocuments>
<ID>0</ID>
<LastName>String</LastName>
<ModifiedBy>String</ModifiedBy>
<Notes>String</Notes>
<Phase>String</Phase>
<Phone>String</Phone>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyNumber>String</PolicyNumber>
<PolicyType>String</PolicyType>
<RegionalOffice>String</RegionalOffice>
<Reminder>
<Reminder>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
</Reminder>
</Reminder>
<SS>String</SS>
<TransactionId>String</TransactionId>
<TransferAmount>String</TransferAmount>
<TransferringCompany>String</TransferringCompany>
</SmartsheetsTransfer>
</Transfer>
</SmartsheetsResponse>