Trendsic Platform Service

<back to all web services

FormInvitesRequest

Requires Authentication
The following routes are available for this service:
GET/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 FormInvitesRequest:
    form_u_i_d: Optional[str] = None

Python FormInvitesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/forms/{FormUID}/invites HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"Invites":[{"InviteUID":"00000000000000000000000000000000","Name":"String","Email":"String","Phone":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ExpiresAt":"0001-01-01T00:00:00.0000000","SentAt":"0001-01-01T00:00:00.0000000","LastSentAt":"0001-01-01T00:00:00.0000000","SendCount":0,"OpenedAt":"0001-01-01T00:00:00.0000000","RevokedAt":"0001-01-01T00:00:00.0000000","Number":"String","State":"String","Link":"String","Sends":[{"Channel":"String","To":"String","Outcome":"String"}]}],"Created":[{"InviteUID":"00000000000000000000000000000000","Name":"String","Email":"String","Phone":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ExpiresAt":"0001-01-01T00:00:00.0000000","SentAt":"0001-01-01T00:00:00.0000000","LastSentAt":"0001-01-01T00:00:00.0000000","SendCount":0,"OpenedAt":"0001-01-01T00:00:00.0000000","RevokedAt":"0001-01-01T00:00:00.0000000","Number":"String","State":"String","Link":"String","Sends":[{"Channel":"String","To":"String","Outcome":"String"}]}],"Emails":0,"Texts":0,"Consequence":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}