Skip to content

Create site

POST
/api/sites
 
curl --request POST \
  --url http://localhost:3000/api/sites \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "name": "example", "slug": "example", "status": "active", "regionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "facility": "example", "latitude": 1, "longitude": 1, "description": "example" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
slug

Auto-generated from name when omitted

string
status
string
default: active
Allowed values: active planned retired
regionId
string format: uuid
facility
string
latitude
number
>= -90 <= 90
longitude
number
>= -180 <= 180
description
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Site created

Media type application/json
object
data
object
id
required
string format: uuid
name
required
string
slug
string
nullable
status
required
string
Allowed values: active planned retired
regionId
string format: uuid
nullable
facility
string
nullable
latitude

Decimal degrees, numeric(9,6) serialised as string

string
nullable
longitude

Decimal degrees, numeric(9,6) serialised as string

string
nullable
description
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example 
{
  "data": {
    "status": "active"
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}