Trendsic Platform Service

FormInviteCreateRequest

The following routes are available for this service:
POST	/v1/forms/{FormUID}/invites

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 FormFillReceiptLine
            Public Overridable Property Channel As String
            Public Overridable Property [To] As String
            Public Overridable Property Outcome As String
        End Class

        Public Partial Class FormInviteCreateRequest
            Public Overridable Property FormUID As Guid
            Public Overridable Property People As List(Of FormInvitePerson) = New List(Of FormInvitePerson)
            Public Overridable Property Preview As Boolean
        End Class

        Public Partial Class FormInvitePerson
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
        End Class

        Public Partial Class FormInvitesResponse
            Public Overridable Property Invites As List(Of FormInviteView) = New List(Of FormInviteView)
            Public Overridable Property Created As List(Of FormInviteView) = New List(Of FormInviteView)
            Public Overridable Property Emails As Integer
            Public Overridable Property Texts As Integer
            Public Overridable Property Consequence As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class FormInviteView
            Public Overridable Property InviteUID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property ExpiresAt As Date?
            Public Overridable Property SentAt As Date?
            Public Overridable Property LastSentAt As Date?
            Public Overridable Property SendCount As Integer
            Public Overridable Property OpenedAt As Date?
            Public Overridable Property RevokedAt As Date?
            Public Overridable Property Number As String
            Public Overridable Property State As String
            Public Overridable Property Link As String
            Public Overridable Property Sends As List(Of FormFillReceiptLine) = New List(Of FormFillReceiptLine)
        End Class
    End Namespace
End Namespace

VB.NET FormInviteCreateRequest 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.

POST /v1/forms/{FormUID}/invites HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormInviteCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <People>
    <FormInvitePerson>
      <Email>String</Email>
      <Name>String</Name>
      <Phone>String</Phone>
    </FormInvitePerson>
  </People>
  <Preview>false</Preview>
</FormInviteCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormInvitesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Consequence>String</Consequence>
  <Created>
    <FormInviteView>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Email>String</Email>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <InviteUID>00000000-0000-0000-0000-000000000000</InviteUID>
      <LastSentAt>0001-01-01T00:00:00</LastSentAt>
      <Link>String</Link>
      <Name>String</Name>
      <Number>String</Number>
      <OpenedAt>0001-01-01T00:00:00</OpenedAt>
      <Phone>String</Phone>
      <RevokedAt>0001-01-01T00:00:00</RevokedAt>
      <SendCount>0</SendCount>
      <Sends>
        <FormFillReceiptLine>
          <Channel>String</Channel>
          <Outcome>String</Outcome>
          <To>String</To>
        </FormFillReceiptLine>
      </Sends>
      <SentAt>0001-01-01T00:00:00</SentAt>
      <State>String</State>
    </FormInviteView>
  </Created>
  <Emails>0</Emails>
  <Invites>
    <FormInviteView>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Email>String</Email>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <InviteUID>00000000-0000-0000-0000-000000000000</InviteUID>
      <LastSentAt>0001-01-01T00:00:00</LastSentAt>
      <Link>String</Link>
      <Name>String</Name>
      <Number>String</Number>
      <OpenedAt>0001-01-01T00:00:00</OpenedAt>
      <Phone>String</Phone>
      <RevokedAt>0001-01-01T00:00:00</RevokedAt>
      <SendCount>0</SendCount>
      <Sends>
        <FormFillReceiptLine>
          <Channel>String</Channel>
          <Outcome>String</Outcome>
          <To>String</To>
        </FormFillReceiptLine>
      </Sends>
      <SentAt>0001-01-01T00:00:00</SentAt>
      <State>String</State>
    </FormInviteView>
  </Invites>
  <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>
  <Texts>0</Texts>
</FormInvitesResponse>