PUT api/studyareas/{id}

Update an existing StudyArea.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The primary key of the StudyArea record in the Hobsons database.

integer

Required

Body Parameters

The StudyArea object which is passed in via the request body.

StudyAreaDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

integer

None.

Name

The name of the study area Ignored for PUT requests sent to the API.

string

Required

String length: inclusive between 0 and 100

Position

Can be used for ordering a collection of records if configured.

integer

Range: inclusive between 1 and 99999999

Inactive

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Position": 1,
  "Inactive": true
}

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1