| POST | /v1/forms/{FormUID}/invites |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type FormFillReceiptLine() =
member val Channel:String = null with get,set
member val To:String = null with get,set
member val Outcome:String = null with get,set
[<AllowNullLiteral>]
type FormInviteView() =
member val InviteUID:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Email:String = null with get,set
member val Phone:String = null with get,set
member val CreatedBy:String = null with get,set
member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SentAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LastSentAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SendCount:Int32 = new Int32() with get,set
member val OpenedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RevokedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Number:String = null with get,set
member val State:String = null with get,set
member val Link:String = null with get,set
member val Sends:ResizeArray<FormFillReceiptLine> = new ResizeArray<FormFillReceiptLine>() with get,set
[<AllowNullLiteral>]
type FormInvitesResponse() =
member val Invites:ResizeArray<FormInviteView> = new ResizeArray<FormInviteView>() with get,set
member val Created:ResizeArray<FormInviteView> = new ResizeArray<FormInviteView>() with get,set
member val Emails:Int32 = new Int32() with get,set
member val Texts:Int32 = new Int32() with get,set
member val Consequence:String = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type FormInvitePerson() =
member val Name:String = null with get,set
member val Email:String = null with get,set
member val Phone:String = null with get,set
[<AllowNullLiteral>]
type FormInviteCreateRequest() =
member val FormUID:Guid = new Guid() with get,set
member val People:ResizeArray<FormInvitePerson> = new ResizeArray<FormInvitePerson>() with get,set
member val Preview:Boolean = new Boolean() with get,set
F# FormInviteCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FormUID: 00000000000000000000000000000000,
People:
[
{
Name: String,
Email: String,
Phone: String
}
],
Preview: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Invites:
[
{
InviteUID: 00000000000000000000000000000000,
Name: String,
Email: String,
Phone: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
ExpiresAt: 0001-01-01,
SentAt: 0001-01-01,
LastSentAt: 0001-01-01,
SendCount: 0,
OpenedAt: 0001-01-01,
RevokedAt: 0001-01-01,
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-01,
ExpiresAt: 0001-01-01,
SentAt: 0001-01-01,
LastSentAt: 0001-01-01,
SendCount: 0,
OpenedAt: 0001-01-01,
RevokedAt: 0001-01-01,
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
}
}
}