ApexERPHost

GetDynamicForms

The following routes are available for this service:
GET	/Core/Dynamic/Forms
GET	/Core/Dynamic/Forms/ByCategory/{CategoryID}

**GetDynamicForms** Parameters:
Name	Parameter	Data Type	Required	Description
CategoryID	path	Guid?	No

**GetDynamicFormsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Result	form	List<DynamicForm>	No

**DynamicForm** Parameters:
Name	Parameter	Data Type	Required
UnId	form	Guid	No
Name	form	string	No
Description	form	string	No
Type	form	int	No
DataSourceId	form	Guid?	No
DataSource	form	DynamicDataSource	No
CategoryId	form	Guid?	No
Script	form	string	No
DynamicPopups	form	List<DynamicPopup>	No
HCode	form	string	No
Visibility	form	bool?	No
Params	form	FormObjParams	No
CopyCount	form	int?	No

**DynamicDataSource** Parameters:
Name	Parameter	Data Type	Required
DsId	form	Guid	No
Name	form	string	No
Description	form	string	No
Query	form	string	No
HasDates	form	bool	No
CategoryId	form	Guid	No
Params	form	List<DynamicDataSourceParam>	No
Hccrt	form	string	No
Used	form	bool?	No
HasParams	form	bool?	No
HCode	form	string	No

**DynamicDataSourceParam** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Description	form	string	No
DataSourceId	form	Guid	No
DbType	form	string	No
Size	form	int	No
QueryId	form	Guid?	No
Format	form	string	No
IsNullable	form	bool	No
OrderIndex	form	int	No

**DynamicPopup** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Data	form	DynamicPopupData	No

**DynamicPopupData** Parameters:
Name	Parameter	Data Type	Required
FormUnId	form	Guid	No
FormLayoutId	form	int?	No
Priority	form	int	No
HideFormParams	form	bool	No
ParamsMap	form	Dictionary<string, string>	No
ShowAsDialog	form	bool?	No

**FormObjParams** Parameters:
Name	Parameter	Data Type	Required
ShowInMenu	form	bool?	No
Image	form	string	No
LargeImage	form	string	No
OrderIndex	form	int?	No
ParentFormType	form	string	No

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 /Core/Dynamic/Forms HTTP/1.1 
Host: 10.10.0.107 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			UnId: 00000000000000000000000000000000,
			Name: String,
			Description: String,
			Type: 0,
			DataSourceId: 00000000000000000000000000000000,
			DataSource: 
			{
				DsId: 00000000000000000000000000000000,
				Name: String,
				Description: String,
				Query: String,
				HasDates: False,
				CategoryId: 00000000000000000000000000000000,
				Params: 
				[
					{
						Id: 00000000000000000000000000000000,
						Name: String,
						Description: String,
						DataSourceId: 00000000000000000000000000000000,
						DbType: String,
						Size: 0,
						QueryId: 00000000000000000000000000000000,
						Format: String,
						IsNullable: False,
						OrderIndex: 0
					}
				],
				Hccrt: String,
				Used: False,
				HasParams: False,
				HCode: String
			},
			CategoryId: 00000000000000000000000000000000,
			Script: String,
			DynamicPopups: 
			[
				{
					Id: 0,
					Name: String,
					Data: 
					{
						FormUnId: 00000000000000000000000000000000,
						FormLayoutId: 0,
						Priority: 0,
						HideFormParams: False,
						ParamsMap: 
						{
							String: String
						},
						ShowAsDialog: False
					}
				}
			],
			HCode: String,
			Visibility: False,
			Params: 
			{
				ShowInMenu: False,
				Image: String,
				LargeImage: String,
				OrderIndex: 0,
				ParentFormType: String
			},
			CopyCount: 0
		}
	]
}