| Required role: | SysAdmin |
| GET | /companies/config | ||
|---|---|---|---|
| GET | /companies/{Code}/config |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | ERPCompanyConfig | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DbParams | form | ERPDbParams | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | DbProviderType | No | |
| ConnectionString | form | string | No | |
| SkipAutoBackup | form | bool | No | |
| SkipMaintenanse | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: 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:
{
DbParams:
{
Type: None,
ConnectionString: String,
SkipAutoBackup: False,
SkipMaintenanse: False
}
}
}