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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FormInvitesRequest
    {
        public UUID FormUID = null;
        
        public UUID getFormUID() { return FormUID; }
        public FormInvitesRequest setFormUID(UUID value) { this.FormUID = value; return this; }
    }

    public static class FormInvitesResponse
    {
        public ArrayList<FormInviteView> Invites = new ArrayList<FormInviteView>();
        public ArrayList<FormInviteView> Created = new ArrayList<FormInviteView>();
        public Integer Emails = null;
        public Integer Texts = null;
        public String Consequence = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<FormInviteView> getInvites() { return Invites; }
        public FormInvitesResponse setInvites(ArrayList<FormInviteView> value) { this.Invites = value; return this; }
        public ArrayList<FormInviteView> getCreated() { return Created; }
        public FormInvitesResponse setCreated(ArrayList<FormInviteView> value) { this.Created = value; return this; }
        public Integer getEmails() { return Emails; }
        public FormInvitesResponse setEmails(Integer value) { this.Emails = value; return this; }
        public Integer getTexts() { return Texts; }
        public FormInvitesResponse setTexts(Integer value) { this.Texts = value; return this; }
        public String getConsequence() { return Consequence; }
        public FormInvitesResponse setConsequence(String value) { this.Consequence = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormInvitesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class FormInviteView
    {
        public UUID InviteUID = null;
        public String Name = null;
        public String Email = null;
        public String Phone = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        public Date ExpiresAt = null;
        public Date SentAt = null;
        public Date LastSentAt = null;
        public Integer SendCount = null;
        public Date OpenedAt = null;
        public Date RevokedAt = null;
        public String Number = null;
        public String State = null;
        public String Link = null;
        public ArrayList<FormFillReceiptLine> Sends = new ArrayList<FormFillReceiptLine>();
        
        public UUID getInviteUID() { return InviteUID; }
        public FormInviteView setInviteUID(UUID value) { this.InviteUID = value; return this; }
        public String getName() { return Name; }
        public FormInviteView setName(String value) { this.Name = value; return this; }
        public String getEmail() { return Email; }
        public FormInviteView setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public FormInviteView setPhone(String value) { this.Phone = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public FormInviteView setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public FormInviteView setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getExpiresAt() { return ExpiresAt; }
        public FormInviteView setExpiresAt(Date value) { this.ExpiresAt = value; return this; }
        public Date getSentAt() { return SentAt; }
        public FormInviteView setSentAt(Date value) { this.SentAt = value; return this; }
        public Date getLastSentAt() { return LastSentAt; }
        public FormInviteView setLastSentAt(Date value) { this.LastSentAt = value; return this; }
        public Integer getSendCount() { return SendCount; }
        public FormInviteView setSendCount(Integer value) { this.SendCount = value; return this; }
        public Date getOpenedAt() { return OpenedAt; }
        public FormInviteView setOpenedAt(Date value) { this.OpenedAt = value; return this; }
        public Date getRevokedAt() { return RevokedAt; }
        public FormInviteView setRevokedAt(Date value) { this.RevokedAt = value; return this; }
        public String getNumber() { return Number; }
        public FormInviteView setNumber(String value) { this.Number = value; return this; }
        public String getState() { return State; }
        public FormInviteView setState(String value) { this.State = value; return this; }
        public String getLink() { return Link; }
        public FormInviteView setLink(String value) { this.Link = value; return this; }
        public ArrayList<FormFillReceiptLine> getSends() { return Sends; }
        public FormInviteView setSends(ArrayList<FormFillReceiptLine> value) { this.Sends = value; return this; }
    }

    public static class FormFillReceiptLine
    {
        public String Channel = null;
        public String To = null;
        public String Outcome = null;
        
        public String getChannel() { return Channel; }
        public FormFillReceiptLine setChannel(String value) { this.Channel = value; return this; }
        public String getTo() { return To; }
        public FormFillReceiptLine setTo(String value) { this.To = value; return this; }
        public String getOutcome() { return Outcome; }
        public FormFillReceiptLine setOutcome(String value) { this.Outcome = value; return this; }
    }

}

Java FormInvitesRequest DTOs

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

HTTP + JSV

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: text/jsv
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
		}
	}
}