POST Agents/List/GetConsentSourceList

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetConsentSourceList

Gets an array of ConsentSource objects.

Query String Parameters

Parameter Name Type Description
$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. 
POST /api/v1/Agents/List/GetConsentSourceList?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: consentSourceIds

The primary keys.

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ConsentSourceId int32 Primary key
Name string Name of consent source
Tooltip string Tooltip for this consent source
Rank int32 Rank of this consent source
Key string The key used to uniquely identify this consent source
MailTemplateId int32 The mail template to use when automatically sending emails to new persons created with this consent source.
Deleted bool true if the ConsentSource is deleted
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/GetConsentSourceList
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "ConsentSourceId": 65,
    "Name": "Gutmann-Hessel",
    "Tooltip": "dolorum",
    "Rank": 678,
    "Key": "est",
    "MailTemplateId": 761,
    "Deleted": false,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 311
      }
    }
  }
]