POST api/bulk/contacts

Insert a collection of contacts in bulk and in one transaction.

Request Information

URI Parameters

None.

Body Parameters

A collection of contacts (maximum accepted: 100).

Collection of ContactDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database. Ignored for PUT (except bulk updates) and POST requests sent to the API.

 integer

None.
StudentId

The unique identifier for the contact in the institution.

 string

String length: inclusive between 0 and 30
SalutationId

A reference to the primary key of the Salutation record that is binded to the contact.

 integer

Range: inclusive between 1 and 99999999
SalutationName

The name of the Salutation record that is binded to the contact. Ignored for PUT and POST requests sent to the API.

 string

None.
Name

The given name of the contact.

 string

String length: inclusive between 0 and 120
Surname

The family name of the contact.

 string

String length: inclusive between 0 and 120
MiddleName

Any additional names that are given to the contact.

 string

String length: inclusive between 0 and 100
Alias

Any aliases that the contact may also be known by.

 string

String length: inclusive between 0 and 120
FormerName

Any names that the contact previously held.

 string

String length: inclusive between 0 and 120
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

Range: inclusive between 1 Jan 1900 and 31 Dec 2099
EmailAddress

The primary email address that is used to communicate with the contact.

 string

String length: inclusive between 0 and 254
IsPermanentResident

Whether the student has a permanent resident visa in the country that the institution is in.

 boolean

Required
CountryOfResidenceId

A reference to the primary key of the Country record that is binded as the contact's country of residence.

 integer

Range: inclusive between 1 and 99999999
CountryOfResidenceName

The name of the Country record that is binded as the contact's country of residence. Ignored for PUT and POST requests sent to the API.

 string

None.
CountryOfCitizenshipId

A reference to the primary key of the Country record that is binded as the contact's country of citizenship.

 integer

Range: inclusive between 1 and 99999999
CountryOfCitizenshipName

The name of the Country record that is binded as the contact's country of citizenship. Ignored for PUT and POST requests sent to the API.

 string

None.
CountryOfBirthId

A reference to the primary key of the Country record that is binded as the contact's country of birth.

 integer

Range: inclusive between 1 and 99999999
CountryOfBirthName

The name of the Country record that is binded as the contact's country of birth. Ignored for PUT and POST requests sent to the API.

 string

None.
DateCreated

The date that the Contact record was created (in the Hobsons database). Ignored for PUT and POST requests sent to the API.

 date

None.
DateModified

The date that the Contact record was last modified (in the Hobsons database). Ignored for PUT and POST requests sent to the API.

 date

None.
HeatStatusId

A reference to the primary key of the HeatStatus record that is binded as the contact's current HeatStatus.

 integer

Required

Range: inclusive between 1 and 99999999
HeatStatusName

The name of the HeatStatus record that is binded as the contacts current HeatStatus. Ignored for PUT and POST requests sent to the API.

 string

None.
HeatStatusChangeReason

The reason why the Contact's HeatStatusId value is changing (or created). The provided value will be stored as part of a new ContactHeatStatus record. Required for PUT requests sent to the API. For POST requests if a reason is not provided, Hobsons will set a default reason. Used ONLY for PUT and POST requests sent to the API. For GET requests always returned as NULL.

 string

String length: inclusive between 0 and 100
SubChannelId

A reference to the primary key of the SubChannel record that is associated with this record. For POST or PUT requests sent to the API where this value is changing, the SubChannel record must belong to the parent Channel named 'External'.

 integer

Required

Range: inclusive between 1 and 99999999
SubChannelName

The name of the SubChannel record that is associated with this record. Ignored for PUT and POST requests sent to the API.

 string

None.
ChannelId

A reference to the primary key of the Channel record that is the parent of the SubChannel record. Ignored for PUT and POST requests sent to the API.

 integer

None.
ChannelName

The name of the Channel record that is the parent of the SubChannel record. Ignored for PUT and POST requests sent to the API.

 string

None.
ContactStatusId

A reference to the primary key of the ContactStatus record that is currently associated with this record.

 integer

Required

Range: inclusive between 1 and 99999999
ContactStatusName

The name of the ContactStatus record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.

 string

None.
ContactStatusChangeReason

The reason why the Contact's ContactStatusId value is changing (or created). The provided value will be stored as part of a new ContactContactStatus record. Required for PUT requests sent to the API. For POST requests if a reason is not provided, Hobsons will set a default reason. Used ONLY for PUT and POST requests sent to the API. For GET requests always returned as NULL.

 string

String length: inclusive between 0 and 100
IntakeId

A reference to the primary key of the Intake record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.

 integer

None.
IntakeName

The name of the Intake record that is currently associated with this record. Ignored for PUT and POST requests sent to the API.

 string

None.
Inactive

boolean

Required

Request Formats

application/json, text/json

Sample: 
[
  {
    "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": "2025-01-22T22:12:56.0388671+11: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": "2025-01-22T22:12:56.0388671+11:00",
    "DateModified": "2025-01-22T22:12:56.0388671+11: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
  },
  {
    "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": "2025-01-22T22:12:56.0388671+11: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": "2025-01-22T22:12:56.0388671+11:00",
    "DateModified": "2025-01-22T22:12:56.0388671+11: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
  }
]

Response Information

Resource Description

A collection of Ids for the inserted contacts (returned in the same order as per the input collection order).

Collection of integer

Response Formats

application/json, text/json

Sample: 
[
  1,
  2
]