POST api/processes/preprocessupsertcontacts

The pre-processor prepares/converts a flat JSON structure of contacts into the hierarchical JSON structure required by the UpsertContact endpoint. Collections like communications can be supplied in the flat structure by repeating multiple rows using the same Personal Identifier (PI) information. The PI information is made of the following fields: EmailAddress, Surname, Name, DateOfBirth, CrmNumber, StudentInstitutionId. If the PI information is the same for 2+ rows then these group of rows are said to be for the same contact.

Request Information

URI Parameters

None.

Body Parameters

Collection of FlatContactUpsertDto

Name	Description	Type	Additional information
CrmNumber		integer	None.
StudentInstitutionId		string	None.
Salutation		string	None.
Name		string	None.
Surname		string	None.
MiddleName		string	None.
Alias		string	None.
FormerName		string	None.
Gender		character	None.
DateOfBirth		date	None.
EmailAddress		string	None.
EmailAddress2		string	None.
Mobile		string	None.
PhoneWork		string	None.
PhoneHome		string	None.
FaxWork		string	None.
FaxHome		string	None.
CorrespondenceStreetAddressLine1		string	None.
CorrespondenceStreetAddressLine2		string	None.
CorrespondenceStreetAddressLine3		string	None.
CorrespondenceTownSuburb		string	None.
CorrespondenceStateCity		string	None.
CorrespondencePostcode		string	None.
CorrespondenceCountry		string	None.
CountryOfBirth		string	None.
CountryOfCitizenship		string	None.
DualCountryOfCitizenship		string	None.
CountryOfResidence		string	None.
IsPermanentResident		boolean	None.
VisaType		string	None.
VisaExpiryDate		date	None.
InclusionStatus		string	None.
HeatStatus		string	None.
HeatStatusReason		string	None.
SubChannel		string	None.
Intake		string	None.
ContactStatus		string	None.
ContactStatusDate		date	None.
ContactStatusReason		string	None.
SubscribedToDirectEmails		boolean	None.
SubscribedToDirectPhoneCalls		boolean	None.
SubscribedToDirectSms		boolean	None.
ContactNoteContent		string	None.
ContactNoteType		string	None.
Inactive		boolean	None.
CreateTask		boolean	None.
TaskType		string	None.
TaskDescription		string	None.
TaskActionDate		date	None.
Tag	Multiple tags can be supplied by supplying additional rows.	string	None.
TagDate		date	None.
ConsentType	Multiple consents can be supplied by supplying additional rows.	string	None.
Consent		boolean	None.
PackageCourses	If true, the collections of courses will all be packaged together under the one single activity. If false, the collections of courses will each be created under their own individual activity. Default: true.	boolean	None.
ActivityPreferenceNumber	Multiple activity course preferences can be supplied by supplying additional rows.	integer	None.
ActivityStudyLevel		string	None.
ActivityFaculty		string	None.
ActivityCourse		string	None.
ActivityDepartment		string	None.
ActivityCampus		string	None.
ActivityStudyArea		string	None.
CommunicationIncoming	Multiple communications can be supplied by supplying additional rows.	boolean	None.
CommunicationCategory		string	None.
CommunicationType		string	None.
CommunicationHeadline		string	None.
CommunicationSubject		string	None.
CommunicationCode		string	None.
CommunicationEffectiveness		string	None.
CommunicationFromEmailAddress		string	None.
CommunicationToEmailAddress		string	None.
CommunicationSendExternal		boolean	None.
CommunicationSource		string	None.
CommunicationReferralSource		string	None.
CommunicationDateCreated		date	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "CrmNumber": 1,
    "StudentInstitutionId": "sample string 1",
    "Salutation": "sample string 2",
    "Name": "sample string 3",
    "Surname": "sample string 4",
    "MiddleName": "sample string 5",
    "Alias": "sample string 6",
    "FormerName": "sample string 7",
    "Gender": "A",
    "DateOfBirth": "2024-05-20T08:56:32.3023915+10:00",
    "EmailAddress": "sample string 8",
    "EmailAddress2": "sample string 9",
    "Mobile": "sample string 10",
    "PhoneWork": "sample string 11",
    "PhoneHome": "sample string 12",
    "FaxWork": "sample string 13",
    "FaxHome": "sample string 14",
    "CorrespondenceStreetAddressLine1": "sample string 15",
    "CorrespondenceStreetAddressLine2": "sample string 16",
    "CorrespondenceStreetAddressLine3": "sample string 17",
    "CorrespondenceTownSuburb": "sample string 18",
    "CorrespondenceStateCity": "sample string 19",
    "CorrespondencePostcode": "sample string 20",
    "CorrespondenceCountry": "sample string 21",
    "CountryOfBirth": "sample string 22",
    "CountryOfCitizenship": "sample string 23",
    "DualCountryOfCitizenship": "sample string 24",
    "CountryOfResidence": "sample string 25",
    "IsPermanentResident": true,
    "VisaType": "sample string 26",
    "VisaExpiryDate": "2024-05-20T08:56:32.3023915+10:00",
    "InclusionStatus": "sample string 27",
    "HeatStatus": "sample string 28",
    "HeatStatusReason": "sample string 29",
    "SubChannel": "sample string 30",
    "Intake": "sample string 31",
    "ContactStatus": "sample string 32",
    "ContactStatusDate": "2024-05-20T08:56:32.3023915+10:00",
    "ContactStatusReason": "sample string 33",
    "SubscribedToDirectEmails": true,
    "SubscribedToDirectPhoneCalls": true,
    "SubscribedToDirectSms": true,
    "ContactNoteContent": "sample string 34",
    "ContactNoteType": "sample string 35",
    "Inactive": true,
    "CreateTask": true,
    "TaskType": "sample string 36",
    "TaskDescription": "sample string 37",
    "TaskActionDate": "2024-05-20T08:56:32.3180398+10:00",
    "Tag": "sample string 38",
    "TagDate": "2024-05-20T08:56:32.3180398+10:00",
    "ConsentType": "sample string 39",
    "Consent": true,
    "PackageCourses": true,
    "ActivityPreferenceNumber": 1,
    "ActivityStudyLevel": "sample string 40",
    "ActivityFaculty": "sample string 41",
    "ActivityCourse": "sample string 42",
    "ActivityDepartment": "sample string 43",
    "ActivityCampus": "sample string 44",
    "ActivityStudyArea": "sample string 45",
    "CommunicationIncoming": true,
    "CommunicationCategory": "sample string 46",
    "CommunicationType": "sample string 47",
    "CommunicationHeadline": "sample string 48",
    "CommunicationSubject": "sample string 49",
    "CommunicationCode": "sample string 50",
    "CommunicationEffectiveness": "sample string 51",
    "CommunicationFromEmailAddress": "sample string 52",
    "CommunicationToEmailAddress": "sample string 53",
    "CommunicationSendExternal": true,
    "CommunicationSource": "sample string 54",
    "CommunicationReferralSource": "sample string 55",
    "CommunicationDateCreated": "2024-05-20T08:56:32.3180398+10:00"
  },
  {
    "CrmNumber": 1,
    "StudentInstitutionId": "sample string 1",
    "Salutation": "sample string 2",
    "Name": "sample string 3",
    "Surname": "sample string 4",
    "MiddleName": "sample string 5",
    "Alias": "sample string 6",
    "FormerName": "sample string 7",
    "Gender": "A",
    "DateOfBirth": "2024-05-20T08:56:32.3023915+10:00",
    "EmailAddress": "sample string 8",
    "EmailAddress2": "sample string 9",
    "Mobile": "sample string 10",
    "PhoneWork": "sample string 11",
    "PhoneHome": "sample string 12",
    "FaxWork": "sample string 13",
    "FaxHome": "sample string 14",
    "CorrespondenceStreetAddressLine1": "sample string 15",
    "CorrespondenceStreetAddressLine2": "sample string 16",
    "CorrespondenceStreetAddressLine3": "sample string 17",
    "CorrespondenceTownSuburb": "sample string 18",
    "CorrespondenceStateCity": "sample string 19",
    "CorrespondencePostcode": "sample string 20",
    "CorrespondenceCountry": "sample string 21",
    "CountryOfBirth": "sample string 22",
    "CountryOfCitizenship": "sample string 23",
    "DualCountryOfCitizenship": "sample string 24",
    "CountryOfResidence": "sample string 25",
    "IsPermanentResident": true,
    "VisaType": "sample string 26",
    "VisaExpiryDate": "2024-05-20T08:56:32.3023915+10:00",
    "InclusionStatus": "sample string 27",
    "HeatStatus": "sample string 28",
    "HeatStatusReason": "sample string 29",
    "SubChannel": "sample string 30",
    "Intake": "sample string 31",
    "ContactStatus": "sample string 32",
    "ContactStatusDate": "2024-05-20T08:56:32.3023915+10:00",
    "ContactStatusReason": "sample string 33",
    "SubscribedToDirectEmails": true,
    "SubscribedToDirectPhoneCalls": true,
    "SubscribedToDirectSms": true,
    "ContactNoteContent": "sample string 34",
    "ContactNoteType": "sample string 35",
    "Inactive": true,
    "CreateTask": true,
    "TaskType": "sample string 36",
    "TaskDescription": "sample string 37",
    "TaskActionDate": "2024-05-20T08:56:32.3180398+10:00",
    "Tag": "sample string 38",
    "TagDate": "2024-05-20T08:56:32.3180398+10:00",
    "ConsentType": "sample string 39",
    "Consent": true,
    "PackageCourses": true,
    "ActivityPreferenceNumber": 1,
    "ActivityStudyLevel": "sample string 40",
    "ActivityFaculty": "sample string 41",
    "ActivityCourse": "sample string 42",
    "ActivityDepartment": "sample string 43",
    "ActivityCampus": "sample string 44",
    "ActivityStudyArea": "sample string 45",
    "CommunicationIncoming": true,
    "CommunicationCategory": "sample string 46",
    "CommunicationType": "sample string 47",
    "CommunicationHeadline": "sample string 48",
    "CommunicationSubject": "sample string 49",
    "CommunicationCode": "sample string 50",
    "CommunicationEffectiveness": "sample string 51",
    "CommunicationFromEmailAddress": "sample string 52",
    "CommunicationToEmailAddress": "sample string 53",
    "CommunicationSendExternal": true,
    "CommunicationSource": "sample string 54",
    "CommunicationReferralSource": "sample string 55",
    "CommunicationDateCreated": "2024-05-20T08:56:32.3180398+10:00"
  }
]

Response Information

Resource Description

Collection of ProcessedContactUpsertDto

Name	Description	Type	Additional information
InRow	The row number in the Input collection of FlatContactUpsertDto passed to the PreProcessUpsertContacts endpoint.	integer	None.
InRelatedRows	A comma separated list of row numbers that are related to the InRow. I.e. these are rows that have the same Personal Identifier (PI) information as the InRow.	string	None.
OutRow	The row number in the Output collection of ProcessedContactUpsertDto returned by the PreProcessUpsertContacts endpoint.	integer	None.
OutData	The Output of processing the InRow (and InRelatedRows) by the PreProcessUpsertContacts endpoint.	ContactUpsertDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InRow": 1,
    "InRelatedRows": "sample string 2",
    "OutRow": 3,
    "OutData": {
      "CrmNumber": 1,
      "StudentInstitutionId": "sample string 1",
      "Salutation": "sample string 2",
      "Name": "sample string 3",
      "Surname": "sample string 4",
      "MiddleName": "sample string 5",
      "Alias": "sample string 6",
      "FormerName": "sample string 7",
      "Gender": "A",
      "DateOfBirth": "2024-05-20T08:56:32.3336554+10:00",
      "EmailAddress": "sample string 8",
      "EmailAddress2": "sample string 9",
      "Mobile": "sample string 10",
      "PhoneWork": "sample string 11",
      "PhoneHome": "sample string 12",
      "FaxWork": "sample string 13",
      "FaxHome": "sample string 14",
      "CorrespondenceStreetAddressLine1": "sample string 15",
      "CorrespondenceStreetAddressLine2": "sample string 16",
      "CorrespondenceStreetAddressLine3": "sample string 17",
      "CorrespondenceTownSuburb": "sample string 18",
      "CorrespondenceStateCity": "sample string 19",
      "CorrespondencePostcode": "sample string 20",
      "CorrespondenceCountry": "sample string 21",
      "CountryOfBirth": "sample string 22",
      "CountryOfCitizenship": "sample string 23",
      "DualCountryOfCitizenship": "sample string 24",
      "CountryOfResidence": "sample string 25",
      "IsPermanentResident": true,
      "VisaType": "sample string 26",
      "VisaExpiryDate": "2024-05-20T08:56:32.3336554+10:00",
      "InclusionStatus": "sample string 27",
      "HeatStatus": "sample string 28",
      "HeatStatusReason": "sample string 29",
      "SubChannel": "sample string 30",
      "Intake": "sample string 31",
      "ContactStatus": "sample string 32",
      "ContactStatusDate": "2024-05-20T08:56:32.3336554+10:00",
      "ContactStatusReason": "sample string 33",
      "SubscribedToDirectEmails": true,
      "SubscribedToDirectPhoneCalls": true,
      "SubscribedToDirectSms": true,
      "ContactNoteContent": "sample string 34",
      "ContactNoteType": "sample string 35",
      "Inactive": true,
      "CreateTask": true,
      "TaskType": "sample string 36",
      "TaskDescription": "sample string 37",
      "TaskActionDate": "2024-05-20T08:56:32.3336554+10:00",
      "Tags": [
        {
          "Tag": "sample string 1",
          "TagDate": "2024-05-20T08:56:32.3336554+10:00"
        },
        {
          "Tag": "sample string 1",
          "TagDate": "2024-05-20T08:56:32.3336554+10:00"
        }
      ],
      "Consents": [
        {
          "Type": "sample string 1",
          "Consent": true
        },
        {
          "Type": "sample string 1",
          "Consent": true
        }
      ],
      "PackageCourses": true,
      "Courses": [
        {
          "PreferenceNumber": 1,
          "StudyLevel": "sample string 1",
          "Faculty": "sample string 2",
          "Course": "sample string 3",
          "Department": "sample string 4",
          "Campus": "sample string 5",
          "StudyArea": "sample string 6"
        },
        {
          "PreferenceNumber": 1,
          "StudyLevel": "sample string 1",
          "Faculty": "sample string 2",
          "Course": "sample string 3",
          "Department": "sample string 4",
          "Campus": "sample string 5",
          "StudyArea": "sample string 6"
        }
      ],
      "Communications": [
        {
          "Incoming": true,
          "Category": "sample string 1",
          "Type": "sample string 2",
          "Headline": "sample string 3",
          "Subject": "sample string 4",
          "Code": "sample string 5",
          "Effectiveness": "sample string 6",
          "FromEmailAddress": "sample string 7",
          "ToEmailAddress": "sample string 8",
          "SendExternal": true,
          "Source": "sample string 9",
          "ReferralSource": "sample string 10",
          "DateCreated": "2024-05-20T08:56:32.34928+10:00"
        },
        {
          "Incoming": true,
          "Category": "sample string 1",
          "Type": "sample string 2",
          "Headline": "sample string 3",
          "Subject": "sample string 4",
          "Code": "sample string 5",
          "Effectiveness": "sample string 6",
          "FromEmailAddress": "sample string 7",
          "ToEmailAddress": "sample string 8",
          "SendExternal": true,
          "Source": "sample string 9",
          "ReferralSource": "sample string 10",
          "DateCreated": "2024-05-20T08:56:32.34928+10:00"
        }
      ]
    }
  },
  {
    "InRow": 1,
    "InRelatedRows": "sample string 2",
    "OutRow": 3,
    "OutData": {
      "CrmNumber": 1,
      "StudentInstitutionId": "sample string 1",
      "Salutation": "sample string 2",
      "Name": "sample string 3",
      "Surname": "sample string 4",
      "MiddleName": "sample string 5",
      "Alias": "sample string 6",
      "FormerName": "sample string 7",
      "Gender": "A",
      "DateOfBirth": "2024-05-20T08:56:32.3336554+10:00",
      "EmailAddress": "sample string 8",
      "EmailAddress2": "sample string 9",
      "Mobile": "sample string 10",
      "PhoneWork": "sample string 11",
      "PhoneHome": "sample string 12",
      "FaxWork": "sample string 13",
      "FaxHome": "sample string 14",
      "CorrespondenceStreetAddressLine1": "sample string 15",
      "CorrespondenceStreetAddressLine2": "sample string 16",
      "CorrespondenceStreetAddressLine3": "sample string 17",
      "CorrespondenceTownSuburb": "sample string 18",
      "CorrespondenceStateCity": "sample string 19",
      "CorrespondencePostcode": "sample string 20",
      "CorrespondenceCountry": "sample string 21",
      "CountryOfBirth": "sample string 22",
      "CountryOfCitizenship": "sample string 23",
      "DualCountryOfCitizenship": "sample string 24",
      "CountryOfResidence": "sample string 25",
      "IsPermanentResident": true,
      "VisaType": "sample string 26",
      "VisaExpiryDate": "2024-05-20T08:56:32.3336554+10:00",
      "InclusionStatus": "sample string 27",
      "HeatStatus": "sample string 28",
      "HeatStatusReason": "sample string 29",
      "SubChannel": "sample string 30",
      "Intake": "sample string 31",
      "ContactStatus": "sample string 32",
      "ContactStatusDate": "2024-05-20T08:56:32.3336554+10:00",
      "ContactStatusReason": "sample string 33",
      "SubscribedToDirectEmails": true,
      "SubscribedToDirectPhoneCalls": true,
      "SubscribedToDirectSms": true,
      "ContactNoteContent": "sample string 34",
      "ContactNoteType": "sample string 35",
      "Inactive": true,
      "CreateTask": true,
      "TaskType": "sample string 36",
      "TaskDescription": "sample string 37",
      "TaskActionDate": "2024-05-20T08:56:32.3336554+10:00",
      "Tags": [
        {
          "Tag": "sample string 1",
          "TagDate": "2024-05-20T08:56:32.3336554+10:00"
        },
        {
          "Tag": "sample string 1",
          "TagDate": "2024-05-20T08:56:32.3336554+10:00"
        }
      ],
      "Consents": [
        {
          "Type": "sample string 1",
          "Consent": true
        },
        {
          "Type": "sample string 1",
          "Consent": true
        }
      ],
      "PackageCourses": true,
      "Courses": [
        {
          "PreferenceNumber": 1,
          "StudyLevel": "sample string 1",
          "Faculty": "sample string 2",
          "Course": "sample string 3",
          "Department": "sample string 4",
          "Campus": "sample string 5",
          "StudyArea": "sample string 6"
        },
        {
          "PreferenceNumber": 1,
          "StudyLevel": "sample string 1",
          "Faculty": "sample string 2",
          "Course": "sample string 3",
          "Department": "sample string 4",
          "Campus": "sample string 5",
          "StudyArea": "sample string 6"
        }
      ],
      "Communications": [
        {
          "Incoming": true,
          "Category": "sample string 1",
          "Type": "sample string 2",
          "Headline": "sample string 3",
          "Subject": "sample string 4",
          "Code": "sample string 5",
          "Effectiveness": "sample string 6",
          "FromEmailAddress": "sample string 7",
          "ToEmailAddress": "sample string 8",
          "SendExternal": true,
          "Source": "sample string 9",
          "ReferralSource": "sample string 10",
          "DateCreated": "2024-05-20T08:56:32.34928+10:00"
        },
        {
          "Incoming": true,
          "Category": "sample string 1",
          "Type": "sample string 2",
          "Headline": "sample string 3",
          "Subject": "sample string 4",
          "Code": "sample string 5",
          "Effectiveness": "sample string 6",
          "FromEmailAddress": "sample string 7",
          "ToEmailAddress": "sample string 8",
          "SendExternal": true,
          "Source": "sample string 9",
          "ReferralSource": "sample string 10",
          "DateCreated": "2024-05-20T08:56:32.34928+10:00"
        }
      ]
    }
  }
]