POST Agents/EMail/FindContactOrPersonByEmailNameWithLimit

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/EMail/FindContactOrPersonByEmailNameWithLimit

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

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/EMail/FindContactOrPersonByEmailNameWithLimit?$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

Name, EmailAddress, NumberOfContacts, NumberOfPersons

Property Name Type Description
Name String
EmailAddress String
NumberOfContacts Integer
NumberOfPersons Integer

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
PersonId int32 The id of the person
FullName string The person fullname
EmailAddress string The emailAddress
ContactId int32 The id of the contact
ContactName string The contact name
ContactDepartment string Department
ContactCategory string Contact category
SortName string If person ? The person name, else contact name
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/EMail/FindContactOrPersonByEmailNameWithLimit
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "Name": "Schmitt, Gutkowski and Kunze",
  "EmailAddress": "kelvin@schustercrooks.name",
  "NumberOfContacts": 997,
  "NumberOfPersons": 260
}

Sample response

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

[
  {
    "PersonId": 84,
    "FullName": "Prof. Maye Friesen",
    "EmailAddress": "javon.lebsack@brekkelang.uk",
    "ContactId": 597,
    "ContactName": "Weimann Inc and Sons",
    "ContactDepartment": "",
    "ContactCategory": "VIP Customer",
    "SortName": "Franecki-Hodkiewicz",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 809
      }
    }
  }
]