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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Attachment
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property TableName As String
            Public Overridable Property FieldName As String
            Public Overridable Property RecordId As Integer
            Public Overridable Property AttachmentName As String
            Public Overridable Property MimeType As String
            Public Overridable Property AttachmentData As Byte() = New Byte(){}
            Public Overridable Property FileSizeInKB As Double
            Public Overridable Property CreatedDate As Date
            Public Overridable Property CreatedBy As String
            Public Overridable Property NeedsOCR As Boolean
            Public Overridable Property OCRDate As Date
            Public Overridable Property IsSecurities As Boolean
            Public Overridable Property AWSKey As String
            Public Overridable Property PresignedUrl As String
        End Class

        Public Partial Class Reminder
            Public Overridable Property ReminderId As Guid
            Public Overridable Property TableName As String
            Public Overridable Property FieldName As String
            Public Overridable Property RecordId As Integer
            Public Overridable Property ReminderDate As Date
            Public Overridable Property ReminderNote As String
            Public Overridable Property CreatedDate As Date
            Public Overridable Property CreatedBy As String
            Public Overridable Property CompletedDate As Date
        End Class

        Public Partial Class SmartsheetsFlow
            Public Overridable Property ID As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property PolicyNumber As String
            Public Overridable Property PolicyType As String
            Public Overridable Property AppDate As String
            Public Overridable Property AgentName As String
            Public Overridable Property AgentID As Integer?
            Public Overridable Property SRAStartDate As String
            Public Overridable Property Phase As String
            Public Overridable Property ModalPremium As String
            Public Overridable Property Frequency As String
            Public Overridable Property AnnualPremium As String
            Public Overridable Property District As String
            Public Overridable Property SS As String
            Public Overridable Property Carrier As String
            Public Overridable Property Notes As String
            Public Overridable Property TPA As String
            Public Overridable Property Flagged As Boolean
            Public Overridable Property Deleted As Boolean
            Public Overridable Property ModifiedBy As String
            Public Overridable Property TransactionId As String
            Public Overridable Property HasChange As Boolean
            Public Overridable Property HasConversation As Boolean
            Public Overridable Property HasAgentMsg As Boolean
            Public Overridable Property HasAdminMsg As Boolean
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
            Public Overridable Property Reminder As List(Of Reminder) = New List(Of Reminder)
            Public Overridable Property Agents As String
            Public Overridable Property HasOCR As Boolean
            Public Overridable Property PolicyAssociateId As Guid
            Public Overridable Property HasRequiredDocuments As Boolean
            Public Overridable Property Phone As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property ApprovedDate As String
            Public Overridable Property ApprovedBy As String
        End Class

        Public Partial Class SmartsheetsIssuedClosed
            Public Overridable Property Type As String
            Public Overridable Property ID As Integer
            Public Overridable Property Flagged As Boolean
            Public Overridable Property Phase As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property PolicyNumber As String
            Public Overridable Property AgentName As String
            Public Overridable Property Notes As String
            Public Overridable Property Deleted As Boolean
            Public Overridable Property ModifiedBy As String
            Public Overridable Property HasChange As Boolean
            Public Overridable Property HasConversation As Boolean
            Public Overridable Property HasAgentMsg As Boolean
            Public Overridable Property HasAdminMsg As Boolean
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
            Public Overridable Property Reminder As List(Of Reminder) = New List(Of Reminder)
            Public Overridable Property HasOCR As Boolean
            Public Overridable Property AppDate As String
            Public Overridable Property TransactionId As String
        End Class

        Public Partial Class SmartsheetsLife
            Public Overridable Property ID As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property PolicyNumber As String
            Public Overridable Property PolicyType As String
            Public Overridable Property CPT As String
            Public Overridable Property AppDate As String
            Public Overridable Property AgentName As String
            Public Overridable Property AgentID As Integer?
            Public Overridable Property Phase As String
            Public Overridable Property Notes As String
            Public Overridable Property TransferAmount As String
            Public Overridable Property AccountNumber As String
            Public Overridable Property Deleted As Boolean
            Public Overridable Property ModifiedBy As String
            Public Overridable Property Flagged As Boolean
            Public Overridable Property TransactionId As String
            Public Overridable Property FaceValue As String
            Public Overridable Property HasChange As Boolean
            Public Overridable Property HasConversation As Boolean
            Public Overridable Property HasAgentMsg As Boolean
            Public Overridable Property HasAdminMsg As Boolean
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
            Public Overridable Property Reminder As List(Of Reminder) = New List(Of Reminder)
            Public Overridable Property Agents As String
            Public Overridable Property HasOCR As Boolean
            Public Overridable Property PolicyAssociateId As Guid
            Public Overridable Property HasRequiredDocuments As Boolean
            Public Overridable Property Phone As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property ApprovedDate As String
            Public Overridable Property ApprovedBy As String
        End Class

        Public Partial Class SmartsheetsRequest
            Public Overridable Property AgentID As Integer
            Public Overridable Property SheetType As String
        End Class

        Public Partial Class SmartsheetsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Life As List(Of SmartsheetsLife) = New List(Of SmartsheetsLife)
            Public Overridable Property Flow As List(Of SmartsheetsFlow) = New List(Of SmartsheetsFlow)
            Public Overridable Property Transfer As List(Of SmartsheetsTransfer) = New List(Of SmartsheetsTransfer)
            Public Overridable Property IssuedClosed As List(Of SmartsheetsIssuedClosed) = New List(Of SmartsheetsIssuedClosed)
        End Class

        Public Partial Class SmartsheetsTransfer
            Public Overridable Property ID As Integer
            Public Overridable Property Flagged As Boolean
            Public Overridable Property Phase As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property PolicyNumber As String
            Public Overridable Property PolicyType As String
            Public Overridable Property AppDate As String
            Public Overridable Property AgentName As String
            Public Overridable Property AgentID As Integer?
            Public Overridable Property RegionalOffice As String
            Public Overridable Property TransferAmount As String
            Public Overridable Property TransferringCompany As String
            Public Overridable Property AccountNumber As String
            Public Overridable Property SS As String
            Public Overridable Property Notes As String
            Public Overridable Property Deleted As Boolean
            Public Overridable Property ModifiedBy As String
            Public Overridable Property TransactionId As String
            Public Overridable Property HasChange As Boolean
            Public Overridable Property HasConversation As Boolean
            Public Overridable Property HasAgentMsg As Boolean
            Public Overridable Property HasAdminMsg As Boolean
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
            Public Overridable Property Reminder As List(Of Reminder) = New List(Of Reminder)
            Public Overridable Property Agents As String
            Public Overridable Property HasOCR As Boolean
            Public Overridable Property PolicyAssociateId As Guid
            Public Overridable Property HasRequiredDocuments As Boolean
            Public Overridable Property Phone As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property ApprovedDate As String
            Public Overridable Property ApprovedBy As String
        End Class
    End Namespace
End Namespace

VB.NET SmartsheetsRequest DTOs

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>