POST Agents/Selection/GetRecipientStatisticsFromContactPersonIds

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Selection/GetRecipientStatisticsFromContactPersonIds

Returns a RecipientStatistics object with a count of addresses, emailaddresses and emailaddresses based on contact and persons in a collection of ContactPersonId.

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/Selection/GetRecipientStatisticsFromContactPersonIds?$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

ContactPersonIds

Property Name Type Description
ContactPersonIds Array

Response:

OK

Response Description
200 OK

Response body: RecipientStatistics

Property Name Type Description
Total int32 Total number of members.
ValidPostalAddresses int32 Number of members with a valid postal address.
ValidEmailAddresses int32 Number of members with a valid email address.
ValidFaxNumbers int32 Number of members with a valid fax number.
NoAddresses int32 Number of members with an invalid address.
NoFaxOrEmails int32 Number of members with no fax or email address.
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/Selection/GetRecipientStatisticsFromContactPersonIds
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "ContactPersonIds": [
    {
      "PersonId": 255,
      "ContactId": 910
    },
    {
      "PersonId": 255,
      "ContactId": 910
    }
  ]
}

Sample response

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

{
  "Total": 963,
  "ValidPostalAddresses": 448,
  "ValidEmailAddresses": 551,
  "ValidFaxNumbers": 135,
  "NoAddresses": 743,
  "NoFaxOrEmails": 73,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 488
    }
  }
}