Class FormEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for FormEntity.
Definition and configuration of a Form
Inheritance
object ←
Carrier ←
FormEntity
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get FormEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var formEntity = agent.GetFormEntity( 123 );
Constructors
Default constructor - defaults any enum props to 0.
Properties
Active
Indicates if this form is active or not
Property Value
bool
Config
The JSON-formatted config of this form
Property Value
string
Description
Detailed description
Property Value
string
EmailFlows
EmailFlows this form is used in (read-only)
Property Value
int[]
Expires
After this datetime, the form will become inactive
Property Value
DateTime
FolderId
The folder which this form belongs to. -1 indicates that the shipment is on the root
Property Value
int
FolderName
The name of the folder for this form
Property Value
string
Primary key
Property Value
int
A short string used as unique id to access this form
Property Value
string
GroupId
The group which this form belongs to.
Property Value
int
MaxSubmits
After this number of submits, the form will become inactive
Property Value
int
Name
The name of this form
Property Value
string
NewTicket
Indicates if this form creates a ticket or not
Property Value
bool
RecaptchaMode
What is the state of the recaptcha configuration? This is a read-only member
NULL if unknown enum value.
Property Value
FormsRecaptchaMode?
See Also
FormEntity.RecaptchaMode_String
RecaptchaMode_String
What is the state of the recaptcha configuration? This is a read-only member
Raw string enum value.
Property Value
string
See Also
FormEntity.RecaptchaMode
Recipe
The JSON-formatted recipe of this form
Property Value
string
Registered
Registered when
Property Value
DateTime
RegisteredAssociateId
Registered by whom
Property Value
int
ResponseShipmentId
The id of the s_shipment that is used to send the response mails
Property Value
int
ScriptId
The CRMScript Macro which will be run when the form is submitted.
Property Value
int
Type
What kind of form is this? Indicates if this is a normal form or a template
NULL if unknown enum value.
Property Value
FormType?
See Also
FormEntity.Type_String
Type_String
What kind of form is this? Indicates if this is a normal form or a template
Raw string enum value.
Property Value
string
See Also
FormEntity.Type
Updated
Last updated when
Property Value
DateTime
UpdatedAssociateId
Last updated by whom
Property Value
int
UpdatedCount
Number of updates made to this record
Property Value
short
See Also
MarketingAgent
