Save Consent Purpose

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/List/SaveConsentPurpose");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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: {Authorization: 'Bearer <token>', '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:53294/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 => "53294",
  CURLOPT_URL => "http://localhost:53294/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 => [
    "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/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 = {
    "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({
    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:53294/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

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/List/SaveConsentPurpose");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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: {Authorization: 'Bearer <token>', '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:53294/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 => "53294",
  CURLOPT_URL => "http://localhost:53294/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 => [
    "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/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 = {
    "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({
    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:53294/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": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

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.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

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

ConsentPurpose

SaveConsentPurpose: Save a ConsentPurpose object

Carrier object for ConsentPurpose. Services for the ConsentPurpose Carrier is available from the List Agent.

Show child attributes

Response

Carrier object for ConsentPurpose. Services for the ConsentPurpose Carrier is available from the List Agent.

Primary key

Name

string

Name of consent purpose

Form text used for the actual checkbox

FormText

string

Text for the consent form, the long text to be shown when asking the end-user for this kind of consent

Key

string

The key used to refer to this purpose, like #Process, #Emarketing etc.

List item tooltip

Active

integer<int32>

Is the consent purpose active or not

UpdatedDate

string<date-time>

The date the consent purpose was last updated in UTC.

UpdatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Deleted

boolean

true if the ConsentPurpose is deleted

Rank

integer<int32>

Rank order

PrivacyStatementDesc

string

Name or description for the privacy statement

PrivacyStatementUrl

string

Url referencing the actual privacy statement

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes