Trendsic Platform Service

<back to all web services

FormInvitesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/invites
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormFillReceiptLine
    {
        public virtual string Channel { get; set; }
        public virtual string To { get; set; }
        public virtual string Outcome { get; set; }
    }

    public partial class FormInvitesRequest
    {
        public virtual Guid FormUID { get; set; }
    }

    public partial class FormInvitesResponse
    {
        public virtual List<FormInviteView> Invites { get; set; } = [];
        public virtual List<FormInviteView> Created { get; set; } = [];
        public virtual int Emails { get; set; }
        public virtual int Texts { get; set; }
        public virtual string Consequence { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class FormInviteView
    {
        public virtual Guid InviteUID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Email { get; set; }
        public virtual string Phone { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
        public virtual DateTime? SentAt { get; set; }
        public virtual DateTime? LastSentAt { get; set; }
        public virtual int SendCount { get; set; }
        public virtual DateTime? OpenedAt { get; set; }
        public virtual DateTime? RevokedAt { get; set; }
        public virtual string Number { get; set; }
        public virtual string State { get; set; }
        public virtual string Link { get; set; }
        public virtual List<FormFillReceiptLine> Sends { get; set; } = [];
    }

}

C# FormInvitesRequest 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/forms/{FormUID}/invites HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>