ApexERPHost

<back to all web services

GetERPCompanyConfig

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/companies/config
GET/companies/{Code}/config
GetERPCompanyConfig Parameters:
NameParameterData TypeRequiredDescription
CodepathstringNo
GetERPCompanyConfigResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformERPCompanyConfigNo
ERPCompanyConfig Parameters:
NameParameterData TypeRequiredDescription
DbParamsformERPDbParamsNo
ERPDbParams Parameters:
NameParameterData TypeRequiredDescription
TypeformDbProviderTypeNo
ConnectionStringformstringNo
SkipAutoBackupformboolNo
SkipMaintenanseformboolNo

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 /companies/config 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: 
	{
		DbParams: 
		{
			Type: None,
			ConnectionString: String,
			SkipAutoBackup: False,
			SkipMaintenanse: False
		}
	}
}