using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Preference/SavePreference");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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: {Authorization: 'Bearer <token>', '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:53294/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 => "53294",
CURLOPT_URL => "http://localhost:53294/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 => [
"Authorization: Bearer <token>",
"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:53294/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 = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', '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:53294/api/v1/Agents/Preference/SavePreference', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Save Preference
Save this preference
NsApiSlow threshold: 1000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Preference/SavePreference");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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: {Authorization: 'Bearer <token>', '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:53294/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 => "53294",
CURLOPT_URL => "http://localhost:53294/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 => [
"Authorization: Bearer <token>",
"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:53294/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 = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', '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:53294/api/v1/Agents/Preference/SavePreference', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
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
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
No Content