using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Contact/GetContactSummary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ContactId\": 123,\n \"Limit\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({ContactId: 123, Limit: 123})
};
fetch('http://localhost:56350/api/v1/Agents/Contact/GetContactSummary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Contact/GetContactSummary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ContactId' => 123,
'Limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Contact/GetContactSummary"
payload = {
"ContactId": 123,
"Limit": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({ContactId: 123, Limit: 123})
};
fetch('http://localhost:56350/api/v1/Agents/Contact/GetContactSummary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Contact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Tickets": [
{
"TicketId": 123,
"TicketStatus": 123,
"Title": "<string>",
"Registered": "2023-11-07T05:31:56Z",
"IconHint": "<string>"
}
],
"Followups": [
{
"AppointmentId": 123,
"DocumentId": 123,
"Date": "2023-11-07T05:31:56Z",
"Description": "<string>",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Documents": [
{
"AppointmentId": 123,
"DocumentId": 123,
"Date": "2023-11-07T05:31:56Z",
"Description": "<string>",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Sales": [
{
"SaleId": 123,
"SaleDate": "2023-11-07T05:31:56Z",
"Probability": 123,
"Heading": "<string>",
"Amount": 123,
"Currency": "<string>",
"AmountInBaseCurrency": 123,
"Status": "Unknown",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Chats": [
{
"ChatSessionId": 123,
"Name": "<string>",
"CompanyName": "<string>",
"FirstMessage": "<string>",
"LastMessage": "<string>",
"WhenRequested": "2023-11-07T05:31:56Z",
"WhenEnded": "2023-11-07T05:31:56Z"
}
]
}Get Contact Summary
Get summary of contact and its recent activity.
NsApiSlow threshold: 2000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Contact/GetContactSummary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ContactId\": 123,\n \"Limit\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({ContactId: 123, Limit: 123})
};
fetch('http://localhost:56350/api/v1/Agents/Contact/GetContactSummary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Contact/GetContactSummary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ContactId' => 123,
'Limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Contact/GetContactSummary"
payload = {
"ContactId": 123,
"Limit": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({ContactId: 123, Limit: 123})
};
fetch('http://localhost:56350/api/v1/Agents/Contact/GetContactSummary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Contact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Tickets": [
{
"TicketId": 123,
"TicketStatus": 123,
"Title": "<string>",
"Registered": "2023-11-07T05:31:56Z",
"IconHint": "<string>"
}
],
"Followups": [
{
"AppointmentId": 123,
"DocumentId": 123,
"Date": "2023-11-07T05:31:56Z",
"Description": "<string>",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Documents": [
{
"AppointmentId": 123,
"DocumentId": 123,
"Date": "2023-11-07T05:31:56Z",
"Description": "<string>",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Sales": [
{
"SaleId": 123,
"SaleDate": "2023-11-07T05:31:56Z",
"Probability": 123,
"Heading": "<string>",
"Amount": 123,
"Currency": "<string>",
"AmountInBaseCurrency": 123,
"Status": "Unknown",
"Completed": "Unknown",
"Registered": "2023-11-07T05:31:56Z"
}
],
"Chats": [
{
"ChatSessionId": 123,
"Name": "<string>",
"CompanyName": "<string>",
"FirstMessage": "<string>",
"LastMessage": "<string>",
"WhenRequested": "2023-11-07T05:31:56Z",
"WhenEnded": "2023-11-07T05:31:56Z"
}
]
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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
ContactId, Limit
Response
OK
Summary of contact with recent activities, chats, and requests included. Carrier object for ContactSummary. Services for the ContactSummary Carrier is available from the Contact Agent.
Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.
Show child attributes
Show child attributes
Recent tickets on contact
Show child attributes
Show child attributes
Recent follow-ups on contact
Show child attributes
Show child attributes
Recent documents on contact
Show child attributes
Show child attributes
Recent sales on contact
Show child attributes
Show child attributes
Recent chats with contact
Show child attributes
Show child attributes
Related topics
Get Contact SummaryNSContactAgentActivitiesGet ContactGet Summary By ContactNSContactSummary