Guestroam API

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

credentials

list

GET /api/credentials/

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action credentials list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["credentials", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["credentials", "list"]
result = client.action(schema, action)

read

GET /api/credentials/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action credentials read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["credentials", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["credentials", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

resend

GET /api/credentials/{id}/resend/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action credentials resend -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["credentials", "resend"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["credentials", "resend"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

departments

list

GET /api/departments/

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action departments list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["departments", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["departments", "list"]
result = client.action(schema, action)

read

GET /api/departments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action departments read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["departments", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["departments", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

guests

list

GET /api/guests/

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action guests list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["guests", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["guests", "list"]
result = client.action(schema, action)

create

POST /api/guests/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`department` required
`firstname` required
`lastname` required
`email` required
`gsm_number` required
`end_date` required
`start_date` required
`contact` required
`language`

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action guests create -p department=... -p firstname=... -p lastname=... -p email=... -p gsm_number=... -p end_date=... -p start_date=... -p contact=... -p language=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["guests", "create"]
var params = {
    department: ...,
    firstname: ...,
    lastname: ...,
    email: ...,
    gsm_number: ...,
    end_date: ...,
    start_date: ...,
    contact: ...,
    language: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["guests", "create"]
params = {
    "department": ...,
    "firstname": ...,
    "lastname": ...,
    "email": ...,
    "gsm_number": ...,
    "end_date": ...,
    "start_date": ...,
    "contact": ...,
    "language": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/guests/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://www.guestroam.be/api/docs/

# Interact with the API endpoint
$ coreapi action guests read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["guests", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://www.guestroam.be/api/docs/")

# Interact with the API endpoint
action = ["guests", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)