Back to Settings This will give the settings for the given CompanyId and UserEmail. Users who are not associated with any Company should pass CompanyId as empty guid(00000000-0000-0000-0000-000000000000).
To be implemented
Lorem ipsum
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyID | Company Id for which settings request made. Users who are not associated with any Company should pass CompanyId as empty guid(00000000-0000-0000-0000-000000000000). | globally unique identifier | Required |
| UserEmail | User email address for which settings request made. | string | Required |
Header Description
| Name | Description | Type |
|---|---|---|
| Content-Type | This is a request content type | application/json |
| Accept | This is a response content type | application/json |
| AuthToken | This is user’s authorization token. | example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US |
Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.
None.
Settings
| Name | Description | Type | ADDITIONAL INFORMATION |
|---|---|---|---|
| StatusCode | This will return Status Code. | HttpStatusCode | None |
| StatusMessage | This will return Status Message. | string | None |
| Message | This will return response message for corresponding status code. | string | None |
| SettingInformation | This will return SettingInformation. If not found will send as null. | APISettings | None |
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"SettingInformation": {
"UserEmail": "sample string 1",
"SettingsFor": "e6fc3d75-fd32-40ef-b0c9-c4c32cdd268e",
"SettingsForType": "sample string 3",
"SettingDetails": {
"3b5c4be7-7e58-41af-805d-7d43b9cf2aa7": {
"ShowOnSettingsTab": 1,
"SettingValue": "sample string 2"
},
"eea4cd51-5bc0-493b-9f33-8df4a9a6f7d7": {
"ShowOnSettingsTab": 1,
"SettingValue": "sample string 2"
}
},
"IsDefaultCompanyUser": true,
"HeaderFooterSettingsList": [
{
"Description": "sample string 1",
"ID": 2
},
{
"Description": "sample string 1",
"ID": 2
}
],
"referenceKeyForIntegration": "sample string 5"
}
}