Forms

More Info

In every response you will receive meta variables FirstID and LastID. Save LastID for future requests so you can use it as a parameter {lastFormID} for every subsequent request until the response meta variable TotalCount is equal to 0, which means you have received all updates.

To get the complete list of forms, start your request with parameter {lastFormID} = 0.

Response definition

Name	Type	Description
MetaCollectionResult\TotalCount	Integer	Total count of forms
MetaCollectionResult\FirstID	Integer	Unique ID of the first item in the list
MetaCollectionResult\LastID	Integer	Unique ID of the last item in the list
FormID	Integer	Unique form ID
FormName	String (255)	Name of the form
ClientCode	String (50)	Unique client code
ClientName	String (255)	Client name
DateAndTime	Datetime	Date and time of creation of this form
RepresentativeCode	String (20)	Unique representative code (author of this form)
RepresentativeName	String (80)	Representative name (author of this form)
StreetAddress	String (255)	Client street address
ZIP	String (20)	Client ZIP code
ZIPExt	String (20)	Client ZIP extension
City	String (255)	Client city
State	String (255)	Client state
Country	String (255)	Client country
Email	String (255)	Client email address
Phone	String (128)	Client phone number
Mobile	String (128)	Client mobile phone number
Territory	String (80)	Territory name this client belongs to
Longitude	Long	Longitude
Latitude	Long	Latitude
SignatureURL	String (512)	Signature image URL
VisitStart	Datetime	Date and time of visit start
VisitEnd	Datetime	Date and time of visit end
Item\Field	String (255)	Custom field name
Item\Value	Text	Custom field value
VisitID	Integer	Unique Visit ID