POST api/intakes

Insert a new Intake.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Id	The primary key of the record in the Hobsons database.	integer	None.
Name		string	Required String length: inclusive between 0 and 100
Code	The client system code for the given record. Must be unique across all active and inactive intake records in the database.	string	Required String length: inclusive between 0 and 100
IsDefault	A flag indicating if this record is the default/current Intake. Only one active intake can be set as the default.	boolean	Required
Position	Can be used for ordering a collection of records if configured.	integer	Range: inclusive between 1 and 99999999
Inactive		boolean	Required
StartDate		date	None.
EndDate		date	None.
CensusDate		date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "IsDefault": true,
  "Position": 1,
  "Inactive": true,
  "StartDate": "2025-01-22T21:43:14.8468243+11:00",
  "EndDate": "2025-01-22T21:43:14.8468243+11:00",
  "CensusDate": "2025-01-22T21:43:14.8468243+11:00"
}

Response Information

Resource Description

The primary key (id) of the Intake record inserted in the Hobsons database.

integer

Response Formats

application/json, text/json

Sample: