API Help Page - Inform System

AppGroups v1

App group endpoints

API	Description
GET api/v1/appgroups	List app group
HEAD api/v1/appgroups	List app group
POST api/v1/appgroups	Create app group
DELETE api/v1/appgroups/{AppGroupId}	Delete app group
GET api/v1/appgroups/{AppGroupId}	Get app group
HEAD api/v1/appgroups/{AppGroupId}	Get app group
PUT api/v1/appgroups/{AppGroupId}	Edit app group

AppGroupMember v1

App group member endpoints

API	Description
DELETE api/v1/appgroups/members	Remove app group member
GET api/v1/appgroups/members	List app group member
HEAD api/v1/appgroups/members	List app group member
PUT api/v1/appgroups/members	Add app group member

AppUser v1

App user endpoints

API	Description
GET api/v1/appusers	List app user
HEAD api/v1/appusers	List app user
POST api/v1/appusers	Create app user
DELETE api/v1/appusers/{AppUserId}	Delete app user
GET api/v1/appusers/{AppUserId}	Get app user
HEAD api/v1/appusers/{AppUserId}	Get app user

Authentication v1

Authentication endpoints

API	Description
POST api/v1/oauth2/environment/token	Get access token
POST api/v1/oauth2/token	Get access token

BusinessGroups v1

Business group endpoints

API	Description
GET api/v1/businessgroups	List business group
HEAD api/v1/businessgroups	List business group

Countries v1

Country endpoints

API	Description
GET api/v1/countries	List country
HEAD api/v1/countries	List country

Customer v1

Customer endpoints

API	Description
GET api/v1/customers	List customer
HEAD api/v1/customers	List customer

DataSource v1

Data source endpoints

API	Description
GET api/v1/datasources	List data source
HEAD api/v1/datasources	List data source
GET api/v1/datasources/file/{DataSourceId}	Download data source file
HEAD api/v1/datasources/file/{DataSourceId}	Download data source file
PUT api/v1/datasources/file/{DataSourceId}	Upload data source file

Forms v1

Form endpoints

API	Description
GET api/v1/forms	List form
HEAD api/v1/forms	List form

FormDataName v1

Form data name endpoints

API	Description
GET api/v1/forms/datanames/{FormId}	List form data name
HEAD api/v1/forms/datanames/{FormId}	List form data name

FormInstruction v1

Form instruction endpoints

API	Description
GET api/v1/forms/instructions/{FormId}/instructions	List form instruction
HEAD api/v1/forms/instructions/{FormId}/instructions	List form instruction
POST api/v1/forms/instructions/{FormId}/instructions	Create form instruction
GET api/v1/forms/instructions/{FormInstructionId}	Retrieve form instruction
HEAD api/v1/forms/instructions/{FormInstructionId}	Retrieve form instruction
PUT api/v1/forms/instructions/{FormInstructionId}/complete	Complete form instruction
PUT api/v1/forms/instructions/{FormInstructionId}/revoke	Revoke form instruction

FormRegistrations v1

Form registration endpoints

API	Description
GET api/v1/forms/registrations	List form registration
HEAD api/v1/forms/registrations	List form registration

FormRegistrationAttachment v1

API	Description
GET api/v1/forms/registrations/attachments/{FormRegistrationAttachmentId}	Download form registration attachment file
HEAD api/v1/forms/registrations/attachments/{FormRegistrationAttachmentId}	Download form registration attachment file

FormRegistrationData v1

Form registration data endpoints

API	Description
GET api/v1/forms/registrations/data Deprecated Superseded by /api/v1/forms/registrations/data/{formRegistrationId}	List form registration data
HEAD api/v1/forms/registrations/data Deprecated Superseded by /api/v1/forms/registrations/data/{formRegistrationId}	List form registration data
GET api/v1/forms/registrations/data/{FormRegistrationId}	List form registration data for registration
HEAD api/v1/forms/registrations/data/{FormRegistrationId}	List form registration data for registration

FormRegistrationEmails v1

Form registration email endpoints

API	Description
GET api/v1/forms/registrations/emails	List form registration email
HEAD api/v1/forms/registrations/emails	List form registration email

FormRegistrationEmailFile v1

API	Description
GET api/v1/forms/registrations/emails/files/{FormRegistrationEmailFileId}	Download form registration email file
HEAD api/v1/forms/registrations/emails/files/{FormRegistrationEmailFileId}	Download form registration email file

FormRegistrationStats v1

Form registration stats endpoints

API	Description
GET api/v1/forms/registrations/stats	List form registration stats
HEAD api/v1/forms/registrations/stats	List form registration stats

InformApp v1

Form instruction endpoints

User endpoints

API	Description
GET api/v1/informapp/forms/{FormId}/instructions	List form instruction
HEAD api/v1/informapp/forms/{FormId}/instructions	List form instruction
POST api/v1/informapp/forms/{FormId}/instructions	Create form instruction
POST api/v1/informapp/forms/{FormId}/instructions/{InstructionId}/complete	Complete form instruction
POST api/v1/informapp/forms/{FormId}/instructions/{InstructionId}/revoke	Revoke form instruction
GET api/v1/informapp/users/{BusinessGroupId}?PageNumber={PageNumber}&PageSize={PageSize}	List users
HEAD api/v1/informapp/users/{BusinessGroupId}?PageNumber={PageNumber}&PageSize={PageSize}	List user

Integrations v1

Integration endpoints

API	Description
POST api/v1/integrations/exports/accept/{IntegrationExportId}	Accept integration export
GET api/v1/integrations/exports/files/{IntegrationExportId}	Download integration export
HEAD api/v1/integrations/exports/files/{IntegrationExportId}	Download integration export
GET api/v1/integrations/exports/queued/me?PageNumber={PageNumber}&PageSize={PageSize}	List integration export queued for me
HEAD api/v1/integrations/exports/queued/me?PageNumber={PageNumber}&PageSize={PageSize}	List integration export queued for me
POST api/v1/integrations/exports/reject/{IntegrationExportId}	Reject integration export
POST api/v1/integrations/exports/report/{IntegrationExportId}	Report integration export
POST api/v1/integrations/imports/files/{IntegrationImportId}	Upload integration import file
POST api/v1/integrations/imports/report/{IntegrationImportId}	Report integration import
POST api/v1/integrations/imports/start	Start integration import
POST api/v1/integrations/users/heartbeats	Create integration user heartbeat

Logs v1

Log endpoints

API	Description
POST api/v1/logs	Create log entries

Ping v1

Ping endpoints

API	Description
GET api/v1/ping	Ping
HEAD api/v1/ping	Ping

TestFiles v1

Test file endpoints

API	Description
POST api/v1/tests/files	Upload test file
PUT api/v1/tests/files	Upload test file
GET api/v1/tests/files?Kind={Kind}	Download test file
HEAD api/v1/tests/files?Kind={Kind}	Download test file

TestMethods v1

Test methods endpoints

API	Description
DELETE api/v1/tests/methods	Test delete
GET api/v1/tests/methods	Test get
HEAD api/v1/tests/methods	Test head
OPTIONS api/v1/tests/methods	Test options
PATCH api/v1/tests/methods	Test patch
POST api/v1/tests/methods	Test post
PUT api/v1/tests/methods	Test put

TestValues v1

Values endpoints

API	Description
GET api/v1/tests/values	List values
HEAD api/v1/tests/values	List values
PUT api/v1/tests/values/body	Test body values
GET api/v1/tests/values/query	Test query values
HEAD api/v1/tests/values/query	Test query values