Skip to main content
Get Recipient Statistics From Contact Person Ids

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

ContactPersonIds

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

ContactPersonIds
object[]

Response

OK

Class representing a RecipientStatistics carrier used for counting attributes on selection members. Carrier object for RecipientStatistics.

Total
integer<int32>

Total number of members.

ValidPostalAddresses
integer<int32>

Number of members with a valid postal address.

ValidEmailAddresses
integer<int32>

Number of members with a valid email address.

ValidFaxNumbers
integer<int32>

Number of members with a valid fax number.

NoAddresses
integer<int32>

Number of members with an invalid address.

NoFaxOrEmails
integer<int32>

Number of members with no fax or email address.

TableRight
object

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

FieldProperties
object

Field property dictionary mapping field names to field access rights.