Trendsic Platform Service

FormInviteCreateRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillReceiptLine:
    channel: Optional[str] = None
    to: Optional[str] = None
    outcome: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInviteView:
    invite_u_i_d: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    expires_at: Optional[datetime.datetime] = None
    sent_at: Optional[datetime.datetime] = None
    last_sent_at: Optional[datetime.datetime] = None
    send_count: int = 0
    opened_at: Optional[datetime.datetime] = None
    revoked_at: Optional[datetime.datetime] = None
    number: Optional[str] = None
    state: Optional[str] = None
    link: Optional[str] = None
    sends: List[FormFillReceiptLine] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInvitesResponse:
    invites: List[FormInviteView] = field(default_factory=list)
    created: List[FormInviteView] = field(default_factory=list)
    emails: int = 0
    texts: int = 0
    consequence: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInvitePerson:
    name: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInviteCreateRequest:
    form_u_i_d: Optional[str] = None
    people: List[FormInvitePerson] = field(default_factory=list)
    preview: bool = False

Python 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>