Little Genie API Documentation

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

# Install the Python client library
$ pip install coreapi

blogs

list

GET /api/v1/blogs/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action blogs 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 = ["blogs", "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.prospello.tech/")

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

read

GET /api/v1/blogs/{id}/

Concrete view for retrieving a model instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this blog.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action blogs 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 = ["blogs", "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.prospello.tech/")

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

course

list

GET /api/v1/course/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action course 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 = ["course", "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.prospello.tech/")

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

read

GET /api/v1/course/{id}/

Concrete view for retrieving a model instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this course.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action course 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 = ["course", "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.prospello.tech/")

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

general

about > read

GET /api/v1/general/about/

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general about read

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 = ["general", "about > read"]
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.prospello.tech/")

# Interact with the API endpoint
action = ["general", "about > read"]
result = client.action(schema, action)

course-enquiry > create

POST /api/v1/general/course-enquiry/

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general course-enquiry create

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 = ["general", "course-enquiry > create"]
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.prospello.tech/")

# Interact with the API endpoint
action = ["general", "course-enquiry > create"]
result = client.action(schema, action)

create-contact > create

POST /api/v1/general/create-contact/

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general create-contact create

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 = ["general", "create-contact > create"]
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.prospello.tech/")

# Interact with the API endpoint
action = ["general", "create-contact > create"]
result = client.action(schema, action)

faq > list

GET /api/v1/general/faq/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general faq 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 = ["general", "faq > 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.prospello.tech/")

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

features > list

GET /api/v1/general/features/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general features 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 = ["general", "features > 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.prospello.tech/")

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

gallery > list

GET /api/v1/general/gallery/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general gallery 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 = ["general", "gallery > 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.prospello.tech/")

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

product-enquiry > create

POST /api/v1/general/product-enquiry/

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general product-enquiry create

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 = ["general", "product-enquiry > create"]
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.prospello.tech/")

# Interact with the API endpoint
action = ["general", "product-enquiry > create"]
result = client.action(schema, action)

socials > list

GET /api/v1/general/socials/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general socials 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 = ["general", "socials > 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.prospello.tech/")

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

testimonials > list

GET /api/v1/general/testimonials/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action general testimonials 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 = ["general", "testimonials > 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.prospello.tech/")

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

products

list

GET /api/v1/products/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action products 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 = ["products", "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.prospello.tech/")

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

read

GET /api/v1/products/{id}/

Concrete view for retrieving a model instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this product.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action products 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 = ["products", "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.prospello.tech/")

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

offers > list

GET /api/v1/products/offers/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action products offers 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 = ["products", "offers > 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.prospello.tech/")

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

teams

list

GET /api/v1/teams/

Concrete view for listing a queryset.

# Load the schema document
$ coreapi get https://www.prospello.tech/

# Interact with the API endpoint
$ coreapi action teams 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 = ["teams", "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.prospello.tech/")

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