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 .xml suffix or ?format=xml

HTTP + 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>