Create new service area
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new service area

  • Dark
    Light
  • PDF

Article summary

Post
/serviceareas/

Operation is used to create new service area. Available from product version 3.0.22.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Service area to be created

object
areaSize
number (float)

Service area size

category
integer

Service area category id

location
string (ewkt) Required

Geographical location

name
string

Service area name

perimeter
number (float)

Service area perimeter length

Responses
201

A created Service area

object
areaSize
number (float)

Service area size

category
integer

Service area category id

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

id
integer

Primary key

location
string (ewkt)

Geographical location

name
string

Service area name

perimeter
number (float)

Service area perimeter length

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

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?