Save Preference
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Preference/SavePreference");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preference\": {\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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preference: {
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/SavePreference', 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/SavePreference",
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([
'Preference' => [
'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/SavePreference"
payload = { "Preference": {
"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({
Preference: {
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/SavePreference', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Save this preference
NsApiSlow threshold: 1000 ms.
Save Preference
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Preference/SavePreference");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Preference\": {\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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Preference: {
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/SavePreference', 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/SavePreference",
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([
'Preference' => [
'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/SavePreference"
payload = { "Preference": {
"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({
Preference: {
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/SavePreference', 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
Preference
SavePreference: Save this preference
One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found. Carrier object for Preference. Services for the Preference Carrier is available from the Preference Agent.
Show child attributes
Show child attributes
Response
204
No Content
Related topics
Save PreferencesSave Preference EntitySave Preference EntitiesSave Preference DescriptionSave Preference Description LinesSave Preference Description Line⌘I