Add Favourites
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Favourite/AddFavourites");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"TableName\": \"<string>\",\n \"RecordIds\": [\n 123\n ],\n \"AssociateId\": 123,\n \"ExtraInfo\": \"<string>\"\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({
TableName: '<string>',
RecordIds: [123],
AssociateId: 123,
ExtraInfo: '<string>'
})
};
fetch('http://localhost:56350/api/v1/Agents/Favourite/AddFavourites', 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/Favourite/AddFavourites",
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([
'TableName' => '<string>',
'RecordIds' => [
123
],
'AssociateId' => 123,
'ExtraInfo' => '<string>'
]),
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/Favourite/AddFavourites"
payload = {
"TableName": "<string>",
"RecordIds": [123],
"AssociateId": 123,
"ExtraInfo": "<string>"
}
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({
TableName: '<string>',
RecordIds: [123],
AssociateId: 123,
ExtraInfo: '<string>'
})
};
fetch('http://localhost:56350/api/v1/Agents/Favourite/AddFavourites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Add a list of record ids as favourites for an associate
NsApiSlow threshold: 2000 ms.
Add Favourites
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Favourite/AddFavourites");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"TableName\": \"<string>\",\n \"RecordIds\": [\n 123\n ],\n \"AssociateId\": 123,\n \"ExtraInfo\": \"<string>\"\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({
TableName: '<string>',
RecordIds: [123],
AssociateId: 123,
ExtraInfo: '<string>'
})
};
fetch('http://localhost:56350/api/v1/Agents/Favourite/AddFavourites', 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/Favourite/AddFavourites",
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([
'TableName' => '<string>',
'RecordIds' => [
123
],
'AssociateId' => 123,
'ExtraInfo' => '<string>'
]),
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/Favourite/AddFavourites"
payload = {
"TableName": "<string>",
"RecordIds": [123],
"AssociateId": 123,
"ExtraInfo": "<string>"
}
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({
TableName: '<string>',
RecordIds: [123],
AssociateId: 123,
ExtraInfo: '<string>'
})
};
fetch('http://localhost:56350/api/v1/Agents/Favourite/AddFavourites', 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
TableName, RecordIds, AssociateId, ExtraInfo
Response
204
No Content
Was this page helpful?