ApexERPHost

<back to all web services

GetFrmObjects

Requires Authentication
The following routes are available for this service:
GET/Core/Frm/Objects
GET/Core/Frm/Objects/{Id}
GetFrmObjects Parameters:
NameParameterData TypeRequiredDescription
CatIdqueryGuid?No
IsDynquerybool?No
IdpathGuid?No
GetFrmObjectsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<FrmObj>No
FrmObj Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
ObjectTypeformint?No
HCodeformstringNo
ParentFormformstringNo
NoteformstringNo
DataSourceIdformGuid?No
IsDynamicformboolNo
CatIdformGuid?No
Visibilityformbool?No
ParamsformFormObjParamsNo
FormObjParams Parameters:
NameParameterData TypeRequiredDescription
ShowInMenuformbool?No
ImageformstringNo
LargeImageformstringNo
OrderIndexformint?No
ParentFormTypeformstringNo

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/Frm/Objects HTTP/1.1 
Host: apex.nikoratrade.ge 
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: 
	[
		{
			Id: 00000000000000000000000000000000,
			Name: String,
			ObjectType: 0,
			HCode: String,
			ParentForm: String,
			Note: String,
			DataSourceId: 00000000000000000000000000000000,
			IsDynamic: False,
			CatId: 00000000000000000000000000000000,
			Visibility: False,
			Params: 
			{
				ShowInMenu: False,
				Image: String,
				LargeImage: String,
				OrderIndex: 0,
				ParentFormType: String
			}
		}
	]
}