Save Preferences
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Preference/SavePreferences");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preferences\": [\n {\n \"RawValue\": \"<string>\",\n \"Specification\": {\n \"Section\": \"<string>\",\n \"Key\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"DisplayValue\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"TabOrder\": {\n \"TabOrderId\": 123,\n \"TabName\": \"<string>\",\n \"Order\": \"<string>\",\n \"AssociateId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"TargetId\": 123,\n \"PrefDescId\": 123,\n \"TableName\": \"<string>\",\n \"UserPreferenceId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: [
{
RawValue: '<string>',
Specification: {
Section: '<string>',
Key: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
DisplayValue: '<string>',
DisplayTooltip: '<string>',
TabOrder: {
TabOrderId: 123,
TabName: '<string>',
Order: '<string>',
AssociateId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
TargetId: 123,
PrefDescId: 123,
TableName: '<string>',
UserPreferenceId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/Preference/SavePreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Preference/SavePreferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Preferences' => [
[
'RawValue' => '<string>',
'Specification' => [
'Section' => '<string>',
'Key' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'DisplayValue' => '<string>',
'DisplayTooltip' => '<string>',
'TabOrder' => [
'TabOrderId' => 123,
'TabName' => '<string>',
'Order' => '<string>',
'AssociateId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'TargetId' => 123,
'PrefDescId' => 123,
'TableName' => '<string>',
'UserPreferenceId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Preference/SavePreferences"
payload = { "Preferences": [
{
"RawValue": "<string>",
"Specification": {
"Section": "<string>",
"Key": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"DisplayValue": "<string>",
"DisplayTooltip": "<string>",
"TabOrder": {
"TabOrderId": 123,
"TabName": "<string>",
"Order": "<string>",
"AssociateId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetId": 123,
"PrefDescId": 123,
"TableName": "<string>",
"UserPreferenceId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: [
{
RawValue: '<string>',
Specification: {
Section: '<string>',
Key: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
DisplayValue: '<string>',
DisplayTooltip: '<string>',
TabOrder: {
TabOrderId: 123,
TabName: '<string>',
Order: '<string>',
AssociateId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
TargetId: 123,
PrefDescId: 123,
TableName: '<string>',
UserPreferenceId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/Preference/SavePreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Save this set of preferences.
Note this method DOES NOT look at level/targetId - it only saves on behalf of the CURRENT USER. NsApiSlow threshold: 1000 ms.
Save Preferences
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Preference/SavePreferences");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preferences\": [\n {\n \"RawValue\": \"<string>\",\n \"Specification\": {\n \"Section\": \"<string>\",\n \"Key\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"DisplayValue\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"TabOrder\": {\n \"TabOrderId\": 123,\n \"TabName\": \"<string>\",\n \"Order\": \"<string>\",\n \"AssociateId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"TargetId\": 123,\n \"PrefDescId\": 123,\n \"TableName\": \"<string>\",\n \"UserPreferenceId\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: [
{
RawValue: '<string>',
Specification: {
Section: '<string>',
Key: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
DisplayValue: '<string>',
DisplayTooltip: '<string>',
TabOrder: {
TabOrderId: 123,
TabName: '<string>',
Order: '<string>',
AssociateId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
TargetId: 123,
PrefDescId: 123,
TableName: '<string>',
UserPreferenceId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/Preference/SavePreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Preference/SavePreferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Preferences' => [
[
'RawValue' => '<string>',
'Specification' => [
'Section' => '<string>',
'Key' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'DisplayValue' => '<string>',
'DisplayTooltip' => '<string>',
'TabOrder' => [
'TabOrderId' => 123,
'TabName' => '<string>',
'Order' => '<string>',
'AssociateId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'TargetId' => 123,
'PrefDescId' => 123,
'TableName' => '<string>',
'UserPreferenceId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Preference/SavePreferences"
payload = { "Preferences": [
{
"RawValue": "<string>",
"Specification": {
"Section": "<string>",
"Key": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"DisplayValue": "<string>",
"DisplayTooltip": "<string>",
"TabOrder": {
"TabOrderId": 123,
"TabName": "<string>",
"Order": "<string>",
"AssociateId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetId": 123,
"PrefDescId": 123,
"TableName": "<string>",
"UserPreferenceId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preferences: [
{
RawValue: '<string>',
Specification: {
Section: '<string>',
Key: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
DisplayValue: '<string>',
DisplayTooltip: '<string>',
TabOrder: {
TabOrderId: 123,
TabName: '<string>',
Order: '<string>',
AssociateId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
TargetId: 123,
PrefDescId: 123,
TableName: '<string>',
UserPreferenceId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/Preference/SavePreferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Preferences
SavePreferences: Save this set of preferences. Note this method DOES NOT look at level/targetId - it only saves on behalf of the CURRENT USER.
Show child attributes
Show child attributes
Response
204
No Content
Related topics
Save PreferenceSave Preference EntitySave Preference EntitiesSave Preference DescriptionSave Preference Description LinesSave Preference Description Line⌘I