Retrieve a specific hall

Retrieves details of a specific hall identified by its unique id. The user must have the necessary permissions to access the hall.

curl -X GET "https://wm.novoai.de/v2/halls/1" \
  -H "Content-Type: application/json" \
  -H "accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-KEY: YOUR_API_KEY"

import requests
import json

url = "https://wm.novoai.de/v2/halls/1"
headers = {
  "Content-Type": "application/json",
  "accept": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-KEY": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://wm.novoai.de/v2/halls/1", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "accept": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-KEY": "YOUR_API_KEY"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://wm.novoai.de/v2/halls/1", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("accept", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://wm.novoai.de/v2/halls/1')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['accept'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-KEY'] = 'YOUR_API_KEY'

response = http.request(request)
puts response.body

{
  "id": 1,
  "name": "Main Hall",
  "description": "Main manufacturing hall",
  "meta_frontend": {},
  "active": true
}

GET

/v2/halls/{id}

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)

Bearer Tokenstring

Required

JWT Bearer token authentication. Include in the Authorization header as Bearer <token>.

API Key (header: X-API-KEY)

X-API-KEYstring

Required

API-Access Key authentication. Include the generated key in the X-API-KEY header.

path

idinteger

Required

The unique identifier of the hall to retrieve.

header

acceptstring

Required

Must be application/json.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token (JWT). JWT Bearer token authentication. Include in the Authorization header as Bearer \<token\>.

header

X-API-KEYstring

Required

API Key for authentication. API-Access Key authentication. Include the generated key in the X-API-KEY header.

Path Parameters

idinteger

Required

The unique identifier of the hall to retrieve.

Example:

1

Headers

acceptstring

Required

Must be application/json.

Example:

application/json

Responses

idinteger

Unique identifier for the hall.

namestring

Name of the hall.

descriptionstring

Description of the hall.

meta_frontendobject

Additional frontend metadata.

activeboolean

Indicates if the hall is active.

Was this page helpful?