POST Agents/Person/GetConsentInfos

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Person/GetConsentInfos

Get all consent information for a given person.

May include withdrawn consents (check NsApiSlow threshold: 2000 ms.

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/Person/GetConsentInfos?$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: request

PersonId

Property Name Type Description
PersonId Integer

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ConsentPersonId int32 Primary key
Comment string Comment regarding this specific consent
Registered date-time When this consent record was created in UTC.
RegisteredAssociateId int32 The ID of the associate who created this record
Updated date-time When this consent record was last updated in UTC.
UpdatedAssociateId int32 The ID of the associate who last updated this record
LegalBaseId int32 Primary key for the LegalBase associated with this consent
LegalBaseKey string Key for the LegalBase associated with this consent
LegalBaseName string Name of the LegalBase associated with this consent
ConsentPurposeId int32 Primary key for the ConsentPurpose associated with this consent
ConsentPurposeKey string Key of the ConsentPurpose associated with this consent
ConsentPurposeName string Name of the ConsentPurpose associated with this consent
ConsentSourceId int32 Primary key for the ConsentSource associated with this consent
ConsentSourceKey string Key of the ConsentSource associated with this consent
ConsentSourceName string Name of the ConsentSource associated with this consent
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/Person/GetConsentInfos
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "PersonId": 413
}

Sample response

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

[
  {
    "ConsentPersonId": 19,
    "Comment": "nobis",
    "Registered": "2001-06-21T02:30:47.5538257+02:00",
    "RegisteredAssociateId": 760,
    "Updated": "2004-07-17T02:30:47.5538257+02:00",
    "UpdatedAssociateId": 943,
    "LegalBaseId": 675,
    "LegalBaseKey": "aliquid",
    "LegalBaseName": "Smitham Inc and Sons",
    "ConsentPurposeId": 909,
    "ConsentPurposeKey": "beatae",
    "ConsentPurposeName": "Johnston, Brekke and Sanford",
    "ConsentSourceId": 457,
    "ConsentSourceKey": "similique",
    "ConsentSourceName": "Boyer, Lindgren and Bergstrom",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 1001
      }
    }
  }
]