using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"LandingPageId\": 123,\n \"AssociateId\": 123,\n \"EntityTableName\": \"<string>\",\n \"SelectionId\": 123,\n \"PinnedSelections\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"PinnedEntities\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Tabs\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"EntityType\": \"<string>\",\n \"Pinned\": true,\n \"Rank\": 123,\n \"ProviderKey\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\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({
LandingPageId: 123,
AssociateId: 123,
EntityTableName: '<string>',
SelectionId: 123,
PinnedSelections: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
PinnedEntities: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Tabs: [
{
Id: 123,
Name: '<string>',
EntityType: '<string>',
Pinned: true,
Rank: 123,
ProviderKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity', 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/Configuration/SaveLandingPageEntity",
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([
'LandingPageId' => 123,
'AssociateId' => 123,
'EntityTableName' => '<string>',
'SelectionId' => 123,
'PinnedSelections' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'PinnedEntities' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Tabs' => [
[
'Id' => 123,
'Name' => '<string>',
'EntityType' => '<string>',
'Pinned' => true,
'Rank' => 123,
'ProviderKey' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'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/Configuration/SaveLandingPageEntity"
payload = {
"LandingPageId": 123,
"AssociateId": 123,
"EntityTableName": "<string>",
"SelectionId": 123,
"PinnedSelections": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"PinnedEntities": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Tabs": [
{
"Id": 123,
"Name": "<string>",
"EntityType": "<string>",
"Pinned": True,
"Rank": 123,
"ProviderKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"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({
LandingPageId: 123,
AssociateId: 123,
EntityTableName: '<string>',
SelectionId: 123,
PinnedSelections: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
PinnedEntities: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Tabs: [
{
Id: 123,
Name: '<string>',
EntityType: '<string>',
Pinned: true,
Rank: 123,
ProviderKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"LandingPageId": 123,
"AssociateId": 123,
"EntityTableName": "<string>",
"SelectionId": 123,
"PinnedSelections": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": true,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"PinnedEntities": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": true,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Tabs": [
{
"Id": 123,
"Name": "<string>",
"EntityType": "<string>",
"TabType": "Unknown",
"Pinned": true,
"Rank": 123,
"ProviderKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Save Landing Page Entity
Updates the existing LandingPageEntity or creates a new LandingPageEntity if the id parameter is 0.
NsApiSlow threshold: 5000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"LandingPageId\": 123,\n \"AssociateId\": 123,\n \"EntityTableName\": \"<string>\",\n \"SelectionId\": 123,\n \"PinnedSelections\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"PinnedEntities\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Tabs\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"EntityType\": \"<string>\",\n \"Pinned\": true,\n \"Rank\": 123,\n \"ProviderKey\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\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({
LandingPageId: 123,
AssociateId: 123,
EntityTableName: '<string>',
SelectionId: 123,
PinnedSelections: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
PinnedEntities: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Tabs: [
{
Id: 123,
Name: '<string>',
EntityType: '<string>',
Pinned: true,
Rank: 123,
ProviderKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity', 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/Configuration/SaveLandingPageEntity",
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([
'LandingPageId' => 123,
'AssociateId' => 123,
'EntityTableName' => '<string>',
'SelectionId' => 123,
'PinnedSelections' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'PinnedEntities' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Tabs' => [
[
'Id' => 123,
'Name' => '<string>',
'EntityType' => '<string>',
'Pinned' => true,
'Rank' => 123,
'ProviderKey' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'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/Configuration/SaveLandingPageEntity"
payload = {
"LandingPageId": 123,
"AssociateId": 123,
"EntityTableName": "<string>",
"SelectionId": 123,
"PinnedSelections": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"PinnedEntities": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Tabs": [
{
"Id": 123,
"Name": "<string>",
"EntityType": "<string>",
"Pinned": True,
"Rank": 123,
"ProviderKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"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({
LandingPageId: 123,
AssociateId: 123,
EntityTableName: '<string>',
SelectionId: 123,
PinnedSelections: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
PinnedEntities: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Tabs: [
{
Id: 123,
Name: '<string>',
EntityType: '<string>',
Pinned: true,
Rank: 123,
ProviderKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveLandingPageEntity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"LandingPageId": 123,
"AssociateId": 123,
"EntityTableName": "<string>",
"SelectionId": 123,
"PinnedSelections": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": true,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"PinnedEntities": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": true,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Tabs": [
{
"Id": 123,
"Name": "<string>",
"EntityType": "<string>",
"TabType": "Unknown",
"Pinned": true,
"Rank": 123,
"ProviderKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Body
The LandingPageEntity that is saved
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Related topics
WebAPI changes in SuperOffice 12.0Save Landing Page TabsDelete Landing Page EntityGet Landing Page EntityCreate Default Landing Page Entitylanding_page table