Company Management API

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

# Install the Python client library
$ pip install coreapi

auth

generate-token > create

POST /api/auth/generate-token/

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Request Body

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

Parameter	Description
`username` required
`password` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action auth generate-token create -p username=... -p password=...

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 = ["auth", "generate-token > create"]
var params = {
    username: ...,
    password: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["auth", "generate-token > create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

refresh-token > create

POST /api/auth/refresh-token/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Request Body

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

Parameter	Description
`refresh` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action auth refresh-token create -p refresh=...

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 = ["auth", "refresh-token > create"]
var params = {
    refresh: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["auth", "refresh-token > create"]
params = {
    "refresh": ...,
}
result = client.action(schema, action, params=params)

verify-token > create

POST /api/auth/verify-token/

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Request Body

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

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action auth verify-token create -p token=...

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 = ["auth", "verify-token > create"]
var params = {
    token: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["auth", "verify-token > create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

company

list

GET /api/company/

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company 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 = ["company", "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://company-management-theta.vercel.app/")

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

create

POST /api/company/

Request Body

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

Parameter	Description
`company_name` required
`company_ceo` required
`company_address` required
`inception_Date` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company create -p company_name=... -p company_ceo=... -p company_address=... -p inception_Date=...

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 = ["company", "create"]
var params = {
    company_name: ...,
    company_ceo: ...,
    company_address: ...,
    inception_Date: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["company", "create"]
params = {
    "company_name": ...,
    "company_ceo": ...,
    "company_address": ...,
    "inception_Date": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company 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 = ["company", "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://company-management-theta.vercel.app/")

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

create_0

POST /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`company_name` required
`company_ceo` required
`company_address` required
`inception_Date` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company create_0 -p id=... -p company_name=... -p company_ceo=... -p company_address=... -p inception_Date=...

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 = ["company", "create_0"]
var params = {
    id: ...,
    company_name: ...,
    company_ceo: ...,
    company_address: ...,
    inception_Date: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["company", "create_0"]
params = {
    "id": ...,
    "company_name": ...,
    "company_ceo": ...,
    "company_address": ...,
    "inception_Date": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`company_name` required
`company_ceo` required
`company_address` required
`inception_Date` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company update -p id=... -p company_name=... -p company_ceo=... -p company_address=... -p inception_Date=...

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 = ["company", "update"]
var params = {
    id: ...,
    company_name: ...,
    company_ceo: ...,
    company_address: ...,
    inception_Date: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["company", "update"]
params = {
    "id": ...,
    "company_name": ...,
    "company_ceo": ...,
    "company_address": ...,
    "inception_Date": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`company_name`
`company_ceo`
`company_address`
`inception_Date`

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company partial_update -p id=... -p company_name=... -p company_ceo=... -p company_address=... -p inception_Date=...

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 = ["company", "partial_update"]
var params = {
    id: ...,
    company_name: ...,
    company_ceo: ...,
    company_address: ...,
    inception_Date: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["company", "partial_update"]
params = {
    "id": ...,
    "company_name": ...,
    "company_ceo": ...,
    "company_address": ...,
    "inception_Date": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/company/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action company delete -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 = ["company", "delete"]
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://company-management-theta.vercel.app/")

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

create-team

create

POST /api/create-team/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

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

Parameter	Description
`team_lead_name` required
`company` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action create-team create -p id=... -p team_lead_name=... -p company=...

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 = ["create-team", "create"]
var params = {
    id: ...,
    team_lead_name: ...,
    company: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["create-team", "create"]
params = {
    "id": ...,
    "team_lead_name": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

get-company

list

GET /api/get-company/

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action get-company 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 = ["get-company", "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://company-management-theta.vercel.app/")

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

read

GET /api/get-company/{name}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action get-company read -p name=...

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 = ["get-company", "read"]
var params = {
    name: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["get-company", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

get-company-details

read

GET /api/get-company-details/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action get-company-details 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 = ["get-company-details", "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://company-management-theta.vercel.app/")

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

get-team

list

GET /api/get-team/

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action get-team 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 = ["get-team", "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://company-management-theta.vercel.app/")

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

team

list

GET /api/team/

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team 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 = ["team", "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://company-management-theta.vercel.app/")

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

create

POST /api/team/

Request Body

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

Parameter	Description
`team_lead_name` required
`company` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team create -p team_lead_name=... -p company=...

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 = ["team", "create"]
var params = {
    team_lead_name: ...,
    company: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["team", "create"]
params = {
    "team_lead_name": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/team/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team 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 = ["team", "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://company-management-theta.vercel.app/")

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

create_0

POST /api/team/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`team_lead_name` required
`company` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team create_0 -p id=... -p team_lead_name=... -p company=...

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 = ["team", "create_0"]
var params = {
    id: ...,
    team_lead_name: ...,
    company: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["team", "create_0"]
params = {
    "id": ...,
    "team_lead_name": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/team/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`team_lead_name` required
`company` required

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team update -p id=... -p team_lead_name=... -p company=...

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 = ["team", "update"]
var params = {
    id: ...,
    team_lead_name: ...,
    company: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["team", "update"]
params = {
    "id": ...,
    "team_lead_name": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/team/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`team_lead_name`
`company`

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team partial_update -p id=... -p team_lead_name=... -p company=...

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 = ["team", "partial_update"]
var params = {
    id: ...,
    team_lead_name: ...,
    company: ...,
}
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://company-management-theta.vercel.app/")

# Interact with the API endpoint
action = ["team", "partial_update"]
params = {
    "id": ...,
    "team_lead_name": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/team/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://company-management-theta.vercel.app/

# Interact with the API endpoint
$ coreapi action team delete -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 = ["team", "delete"]
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://company-management-theta.vercel.app/")

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