POST api/interactionspackage
Insert an Interaction plus its related records.
Request Information
URI Parameters
None.
Body Parameters
InteractionPackageDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Interaction |
The Interaction record to create. |
InteractionDto |
Required |
| InteractionCourses |
A collection of InteractionCourse records to create that will be associated with the Interaction record. Note: for each of the items supplied in this collection: set InteractionId to 1, as once it passes range validation, it will be ignored and automatically assigned to the id of the created Interaction record. Likewise set OrderNumber to 1 as it will be ignored and automatically assigned based on the order the items are supplied in this collection. |
Collection of InteractionCourseDto |
Max items: 50 |
Request Formats
application/json, text/json
Sample:
{
"Interaction": {
"Id": 1,
"CrmNumber": 1,
"ExtApplicationId": "sample string 2",
"ExtOfferId": "sample string 3",
"InteractionTypeId": 4,
"InteractionTypeName": "sample string 5",
"InteractionDate": "2025-10-25T05:01:32.5183034+11:00",
"ContactStatusId": 6,
"ContactStatusName": "sample string 7",
"IntakeId": 8,
"IntakeName": "sample string 9",
"Sponsor": "sample string 10",
"Under18": true,
"SubChannelId": 11,
"SubChannelName": "sample string 12",
"DateCreated": "2025-10-25T05:01:32.5183034+11:00",
"DateUpdated": "2025-10-25T05:01:32.5183034+11:00",
"Inactive": true,
"Task": {
"TaskTypeId": 1,
"Description": "sample string 2"
}
},
"InteractionCourses": [
{
"Id": 1,
"InteractionId": 2,
"OrderNumber": 3,
"StudyLevelId": 1,
"StudyLevelName": "sample string 4",
"FacultyId": 1,
"FacultyName": "sample string 5",
"CourseId": 1,
"CourseName": "sample string 6",
"DepartmentId": 1,
"DepartmentName": "sample string 7",
"CampusId": 1,
"CampusName": "sample string 8",
"StudyAreaId": 1,
"StudyAreaName": "sample string 9"
},
{
"Id": 1,
"InteractionId": 2,
"OrderNumber": 3,
"StudyLevelId": 1,
"StudyLevelName": "sample string 4",
"FacultyId": 1,
"FacultyName": "sample string 5",
"CourseId": 1,
"CourseName": "sample string 6",
"DepartmentId": 1,
"DepartmentName": "sample string 7",
"CampusId": 1,
"CampusName": "sample string 8",
"StudyAreaId": 1,
"StudyAreaName": "sample string 9"
}
]
}
Response Information
Resource Description
The primary key (id) of the Interaction record inserted in the Hobsons database.
integerResponse Formats
application/json, text/json
Sample:
1