GET api/processes/exportcommunications?lastTraceId={lastTraceId}&traceDateFrom={traceDateFrom}&traceDateTo={traceDateTo}&limit={limit}

Exports all communications (that are linked to a contact) optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

Name	Description	Type	Additional information
lastTraceId	Optional filter on records that were traced after the provided id.	integer	None.
traceDateFrom	Optional filter on records that were traced from the provided date.	date	None.
traceDateTo	Optional filter on records that were traced up to (inclusive) the provided date.	date	None.
limit	The maximum amount of Communications that can be returned in any one call. Maximum allowed is 999.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

CommunicationExportDto

Name	Type	Additional information
Communication	CommunicationDto	None.
Contact	ContactDto	None.
ContactContactNumbers	Collection of ContactContactNumberDto	None.
ContactSubscriptionStatus	ContactSubscriptionStatusDto	None.
CurrentContactActivityCourse	ActivityCourseDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Communication": {
    "Id": 1,
    "CrmNumber": 1,
    "Subject": "sample string 2",
    "Headline": "sample string 3",
    "Incoming": true,
    "CommunicationTypeId": 1,
    "CommunicationTypeName": "sample string 5",
    "CommunicationCategoryId": 6,
    "CommunicationCategoryName": "sample string 7",
    "CommunicationEffectivenessId": 1,
    "CommunicationEffectivenessName": "sample string 8",
    "From": "sample string 9",
    "To": "sample string 10",
    "Cc": "sample string 11",
    "Bcc": "sample string 12",
    "SubChannelId": 1,
    "SubChannelName": "sample string 13",
    "ChannelId": 1,
    "ChannelName": "sample string 14",
    "Source": "sample string 15",
    "ReferralSource": "sample string 16",
    "DateCreated": "2024-05-20T12:16:42.2646586+10:00"
  },
  "Contact": {
    "Id": 1,
    "StudentId": "sample string 2",
    "SalutationId": 1,
    "SalutationName": "sample string 3",
    "Name": "sample string 4",
    "Surname": "sample string 5",
    "MiddleName": "sample string 6",
    "Alias": "sample string 7",
    "FormerName": "sample string 8",
    "Gender": "A",
    "DateOfBirth": "2024-05-20T12:16:42.2646586+10:00",
    "EmailAddress": "sample string 9",
    "IsPermanentResident": true,
    "CountryOfResidenceId": 1,
    "CountryOfResidenceName": "sample string 11",
    "CountryOfCitizenshipId": 1,
    "CountryOfCitizenshipName": "sample string 12",
    "CountryOfBirthId": 1,
    "CountryOfBirthName": "sample string 13",
    "DateCreated": "2024-05-20T12:16:42.2646586+10:00",
    "DateModified": "2024-05-20T12:16:42.2646586+10:00",
    "HeatStatusId": 1,
    "HeatStatusName": "sample string 14",
    "HeatStatusChangeReason": "sample string 15",
    "SubChannelId": 1,
    "SubChannelName": "sample string 16",
    "ChannelId": 1,
    "ChannelName": "sample string 17",
    "ContactStatusId": 1,
    "ContactStatusName": "sample string 18",
    "ContactStatusChangeReason": "sample string 19",
    "IntakeId": 1,
    "IntakeName": "sample string 20",
    "Inactive": true
  },
  "ContactContactNumbers": [
    {
      "CrmNumber": 1,
      "ContactNumberTypeId": 2,
      "ContactNumberTypeName": "sample string 3",
      "CountryCode": "sample string 4",
      "AreaCode": "sample string 5",
      "Number": "sample string 6"
    },
    {
      "CrmNumber": 1,
      "ContactNumberTypeId": 2,
      "ContactNumberTypeName": "sample string 3",
      "CountryCode": "sample string 4",
      "AreaCode": "sample string 5",
      "Number": "sample string 6"
    }
  ],
  "ContactSubscriptionStatus": {
    "CrmNumber": 1,
    "SubscribedToDirectEmails": true,
    "SubscribedToDirectPhoneCalls": true,
    "SubscribedToDirectSms": true
  },
  "CurrentContactActivityCourse": {
    "Id": 1,
    "ActivityId": 2,
    "DateCreated": "2024-05-20T12:16:42.280274+10:00",
    "PreferenceNumber": 3,
    "SubChannelId": 4,
    "SubChannelName": "sample string 5",
    "StudyLevelId": 1,
    "StudyLevelName": "sample string 6",
    "FacultyId": 1,
    "FacultyName": "sample string 7",
    "CourseId": 1,
    "CourseName": "sample string 8",
    "DepartmentId": 1,
    "DepartmentName": "sample string 9",
    "CampusId": 1,
    "CampusName": "sample string 10",
    "StudyAreaId": 1,
    "StudyAreaName": "sample string 11"
  }
}