Save Consent Purpose
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConsentPurpose\": {\n \"ConsentPurposeId\": 123,\n \"Name\": \"<string>\",\n \"ConsentText\": \"<string>\",\n \"FormText\": \"<string>\",\n \"Key\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Active\": 123,\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Deleted\": true,\n \"Rank\": 123,\n \"PrivacyStatementDesc\": \"<string>\",\n \"PrivacyStatementUrl\": \"<string>\",\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({
ConsentPurpose: {
ConsentPurposeId: 123,
Name: '<string>',
ConsentText: '<string>',
FormText: '<string>',
Key: '<string>',
Tooltip: '<string>',
Active: 123,
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Rank: 123,
PrivacyStatementDesc: '<string>',
PrivacyStatementUrl: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose', 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/List/SaveConsentPurpose",
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([
'ConsentPurpose' => [
'ConsentPurposeId' => 123,
'Name' => '<string>',
'ConsentText' => '<string>',
'FormText' => '<string>',
'Key' => '<string>',
'Tooltip' => '<string>',
'Active' => 123,
'UpdatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Deleted' => true,
'Rank' => 123,
'PrivacyStatementDesc' => '<string>',
'PrivacyStatementUrl' => '<string>',
'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/List/SaveConsentPurpose"
payload = { "ConsentPurpose": {
"ConsentPurposeId": 123,
"Name": "<string>",
"ConsentText": "<string>",
"FormText": "<string>",
"Key": "<string>",
"Tooltip": "<string>",
"Active": 123,
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": True,
"Rank": 123,
"PrivacyStatementDesc": "<string>",
"PrivacyStatementUrl": "<string>",
"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({
ConsentPurpose: {
ConsentPurposeId: 123,
Name: '<string>',
ConsentText: '<string>',
FormText: '<string>',
Key: '<string>',
Tooltip: '<string>',
Active: 123,
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Rank: 123,
PrivacyStatementDesc: '<string>',
PrivacyStatementUrl: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ConsentPurposeId": 123,
"Name": "<string>",
"ConsentText": "<string>",
"FormText": "<string>",
"Key": "<string>",
"Tooltip": "<string>",
"Active": 123,
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": true,
"Rank": 123,
"PrivacyStatementDesc": "<string>",
"PrivacyStatementUrl": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Save Consent Purpose
Save a ConsentPurpose object
NsApiSlow threshold: 5000 ms.
Save Consent Purpose
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConsentPurpose\": {\n \"ConsentPurposeId\": 123,\n \"Name\": \"<string>\",\n \"ConsentText\": \"<string>\",\n \"FormText\": \"<string>\",\n \"Key\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Active\": 123,\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Deleted\": true,\n \"Rank\": 123,\n \"PrivacyStatementDesc\": \"<string>\",\n \"PrivacyStatementUrl\": \"<string>\",\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({
ConsentPurpose: {
ConsentPurposeId: 123,
Name: '<string>',
ConsentText: '<string>',
FormText: '<string>',
Key: '<string>',
Tooltip: '<string>',
Active: 123,
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Rank: 123,
PrivacyStatementDesc: '<string>',
PrivacyStatementUrl: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose', 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/List/SaveConsentPurpose",
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([
'ConsentPurpose' => [
'ConsentPurposeId' => 123,
'Name' => '<string>',
'ConsentText' => '<string>',
'FormText' => '<string>',
'Key' => '<string>',
'Tooltip' => '<string>',
'Active' => 123,
'UpdatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Deleted' => true,
'Rank' => 123,
'PrivacyStatementDesc' => '<string>',
'PrivacyStatementUrl' => '<string>',
'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/List/SaveConsentPurpose"
payload = { "ConsentPurpose": {
"ConsentPurposeId": 123,
"Name": "<string>",
"ConsentText": "<string>",
"FormText": "<string>",
"Key": "<string>",
"Tooltip": "<string>",
"Active": 123,
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": True,
"Rank": 123,
"PrivacyStatementDesc": "<string>",
"PrivacyStatementUrl": "<string>",
"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({
ConsentPurpose: {
ConsentPurposeId: 123,
Name: '<string>',
ConsentText: '<string>',
FormText: '<string>',
Key: '<string>',
Tooltip: '<string>',
Active: 123,
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Rank: 123,
PrivacyStatementDesc: '<string>',
PrivacyStatementUrl: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/List/SaveConsentPurpose', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ConsentPurposeId": 123,
"Name": "<string>",
"ConsentText": "<string>",
"FormText": "<string>",
"Key": "<string>",
"Tooltip": "<string>",
"Active": 123,
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": true,
"Rank": 123,
"PrivacyStatementDesc": "<string>",
"PrivacyStatementUrl": "<string>",
"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.
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
ConsentPurpose
SaveConsentPurpose: Save a ConsentPurpose object
Carrier object for ConsentPurpose. Services for the ConsentPurpose Carrier is available from the List Agent.
Show child attributes
Show child attributes
Response
OK
Carrier object for ConsentPurpose. Services for the ConsentPurpose Carrier is available from the List Agent.
Primary key
Name of consent purpose
Form text used for the actual checkbox
Text for the consent form, the long text to be shown when asking the end-user for this kind of consent
The key used to refer to this purpose, like #Process, #Emarketing etc.
List item tooltip
Is the consent purpose active or not
The date the consent purpose was last updated in UTC.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Show child attributes
Show child attributes
true if the ConsentPurpose is deleted
Rank order
Name or description for the privacy statement
Url referencing the actual privacy statement
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
Put Consent PurposeDelete Consent PurposePost Consent PurposeNSListAgentSave Consent PersonPut Consent Purpose Headings⌘I