POST api/processes/getcontactactivepreference?contactMatchingMinConfirmedScore={contactMatchingMinConfirmedScore}&contactMatchingMinNameSimilarity={contactMatchingMinNameSimilarity}&contactMatchingEnabled={contactMatchingEnabled}

Gets information for applying the appropriate update logic for client integrations and automated data loads.

Request Information

URI Parameters

Name	Description	Type	Additional information
contactMatchingMinConfirmedScore	The matched contact with the highest score greater or equal than this value will be retrieved. Note: if there are multiple matched contacts with the same highest score, then the contact with the highest CrmNumber will be retrieved.	integer	Default value is 82
contactMatchingMinNameSimilarity	A percentage value to set the minimum similarity of a name search criteria to its potential fuzzy matches. Reducing the similarity percentage will return more names and will also adversely affect performance.	decimal number	Default value is 0.4
contactMatchingEnabled	If set to false, Contact Matching will NOT be done. Therefore if CrmNumber is not provided, the action will return a 404 Not Found HTTP Response automatically.	boolean	Default value is True

Body Parameters

The filtering details to match contacts.

ContactActivePreferenceFilterDto

Name	Description	Type	Additional information
CrmNumber	A reference to the primary key of the Contact record that will be retrieved. If supplied must exist and then that record will be retrieved. If not supplied, key contact fields will be used to match (if enabled) against a contact. If a suitable match found then that record will be retrieved.	integer	None.
StudentInstitutionId	The unique identifier for the contact in the institution.	string	None.
Name	The given name of the contact.	string	None.
Surname	The family name of the contact.	string	None.
MiddleName	Any additional names that are given to the contact.	string	None.
Alias	Any aliases that the contact may also be known by.	string	None.
FormerName	Any names that the contact previously held.	string	None.
Gender	The gender of the Contact. Valid values are 'M', 'F', 'X' and 'N', which denote Male, Female, Gender Neutral and Not Disclosed respectively.	character	None.
DateOfBirth	The date of birth of the contact. Note that only the date component it's used, the time component will be ignored if specified.	date	None.
EmailAddress	The primary email address that is used to communicate with the contact.	string	None.
EmailAddress2	The alternate email address that is used to communicate with the contact.	string	None.
Mobile		string	None.
PhoneHome		string	None.

Request Formats

application/json, text/json

Sample:

{
  "CrmNumber": 1,
  "StudentInstitutionId": "sample string 1",
  "Name": "sample string 2",
  "Surname": "sample string 3",
  "MiddleName": "sample string 4",
  "Alias": "sample string 5",
  "FormerName": "sample string 6",
  "Gender": "A",
  "DateOfBirth": "2024-05-20T12:28:33.9130199+10:00",
  "EmailAddress": "sample string 7",
  "EmailAddress2": "sample string 8",
  "Mobile": "sample string 9",
  "PhoneHome": "sample string 10"
}

Response Information

Resource Description

ContactActivePreferenceDto

Name	Type	Additional information
Contact	ContactDto	None.
CurrentActivity	ActivityDto	None.
CurrentIntake	IntakeDto	None.
CurrentActivityCourse	ActivityCourseDto	None.

Response Formats

application/json, text/json

Sample:

{
  "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:28:33.9130199+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:28:33.9130199+10:00",
    "DateModified": "2024-05-20T12:28:33.9130199+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
  },
  "CurrentActivity": {
    "Id": 1,
    "CrmNumber": 2,
    "ContactStatusId": 1,
    "ContactStatusName": "sample string 3",
    "IntakeId": 1,
    "IntakeName": "sample string 4",
    "DateCreated": "2024-05-20T12:28:33.9130199+10:00",
    "Task": {
      "TaskTypeId": 1,
      "Description": "sample string 2"
    }
  },
  "CurrentIntake": {
    "Id": 1,
    "Name": "sample string 2",
    "Code": "sample string 3",
    "IsDefault": true,
    "Position": 1,
    "Inactive": true,
    "StartDate": "2024-05-20T12:28:33.9130199+10:00",
    "EndDate": "2024-05-20T12:28:33.9130199+10:00",
    "CensusDate": "2024-05-20T12:28:33.9130199+10:00"
  },
  "CurrentActivityCourse": {
    "Id": 1,
    "ActivityId": 2,
    "DateCreated": "2024-05-20T12:28:33.9130199+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"
  }
}