Create new free area
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new free area
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/free-areas/
Operation is used to create free area. Available from product version 3.2.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
Free area to be created
object
FreeArea
area_size
string
color
string
Free area color
created_by
string
Created by user
location
string (ewkt) Required
Geographical location as EWKT representation
name
string
Name of plan
perimeter
string
plan
integer
id of plan
state
integer
id of free area state
type
integer Required
id of type free area type. Only types that are linked to Categories are available for the types of FreeArea
Responses
204
A created free area
object
FreeArea
area_size
string
color
string
Free area color
created_by
string
Created by user
created_date
string (date-time)
Date of create
id
integer
Unique id of free area
location
string (ewkt)
Geographical location as EWKT representation
name
string
Name of plan
perimeter
string
plan
integer
id of plan
state
integer
id of free area state
type
integer
id of type free area type. Only types that are linked to Categories are available for the types of FreeArea
updated_by
string
Updated by user
updated_date
string (date-time)
Date of update
400
There was an error in request. Usually field validation failed.
{
"location": [
"This field is required."
]
}object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
