DEV Cropnuts Portal API

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

# Install the Python client library
$ pip install coreapi

api

v1 > agent-analyis > list

GET /api/v1/agent-analyis/

Using Function CustomerPriceList_View

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 agent-analyis 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 = ["api", "v1 > agent-analyis > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > agent-analyis > list"]
result = client.action(schema, action)

v1 > agent-crops > list

GET /api/v1/agent-crops/

Returns Client Specific Crops.ie Crops for a given Client ID

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 agent-crops 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 = ["api", "v1 > agent-crops > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > agent-crops > list"]
result = client.action(schema, action)

v1 > all-fields > list

GET /api/v1/all-fields/

Returns Fields for the logged in user. If user is commercial agent, returns fields for the sales region If user is DU agent, returns fields for the client If user is business partner, returns fields for the business partner

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 all-fields 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 = ["api", "v1 > all-fields > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > all-fields > list"]
result = client.action(schema, action)

v1 > batch > details > list

GET /api/v1/batch/{batch_code}/details/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch details list -p batch_code=...

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 = ["api", "v1 > batch > details > list"]
var params = {
    batch_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch > details > list"]
params = {
    "batch_code": ...,
}
result = client.action(schema, action, params=params)

v1 > batch > status > list

GET /api/v1/batch/{batch_code}/status/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch status list -p batch_code=...

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 = ["api", "v1 > batch > status > list"]
var params = {
    batch_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch > status > list"]
params = {
    "batch_code": ...,
}
result = client.action(schema, action, params=params)

v1 > batch-results > read

GET /api/v1/batch-results/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch-results 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 = ["api", "v1 > batch-results > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch-results > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > batch-samples > create

POST /api/v1/batch-samples/

Request Body

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

Parameter	Description
`batch_code`
`batch_date` required
`group_code` required
`farm_code` required
`client_id` required
`ref_no`
`app_version`
`samples` required
`account_number` required
`amount` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch-samples create -p batch_code=... -p batch_date=... -p group_code=... -p farm_code=... -p client_id=... -p ref_no=... -p app_version=... -p samples=... -p account_number=... -p amount=...

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 = ["api", "v1 > batch-samples > create"]
var params = {
    batch_code: ...,
    batch_date: ...,
    group_code: ...,
    farm_code: ...,
    client_id: ...,
    ref_no: ...,
    app_version: ...,
    samples: ...,
    account_number: ...,
    amount: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch-samples > create"]
params = {
    "batch_code": ...,
    "batch_date": ...,
    "group_code": ...,
    "farm_code": ...,
    "client_id": ...,
    "ref_no": ...,
    "app_version": ...,
    "samples": ...,
    "account_number": ...,
    "amount": ...,
}
result = client.action(schema, action, params=params)

v1 > batch-update > update

PUT /api/v1/batch-update/{batch_code}/

Update Batch to set the LPO use the ref_no field

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required	A unique value identifying this Batch.

Request Body

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

Parameter	Description
`ref_no` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch-update update -p batch_code=... -p ref_no=...

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 = ["api", "v1 > batch-update > update"]
var params = {
    batch_code: ...,
    ref_no: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch-update > update"]
params = {
    "batch_code": ...,
    "ref_no": ...,
}
result = client.action(schema, action, params=params)

v1 > batch-update > partial_update

PATCH /api/v1/batch-update/{batch_code}/

Update Batch to set the LPO use the ref_no field

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required	A unique value identifying this Batch.

Request Body

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

Parameter	Description
`ref_no`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 batch-update partial_update -p batch_code=... -p ref_no=...

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 = ["api", "v1 > batch-update > partial_update"]
var params = {
    batch_code: ...,
    ref_no: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > batch-update > partial_update"]
params = {
    "batch_code": ...,
    "ref_no": ...,
}
result = client.action(schema, action, params=params)

v1 > client > farms > list

GET /api/v1/client/{id}/farms/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client farms list -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 = ["api", "v1 > client > farms > list"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > client > farms > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > client-batches > read

GET /api/v1/client-batches/{client_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client-batches read -p client_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 = ["api", "v1 > client-batches > read"]
var params = {
    client_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > client-batches > read"]
params = {
    "client_id": ...,
}
result = client.action(schema, action, params=params)

v1 > client-crops > read

GET /api/v1/client-crops/{client_id}/

Returns Crops for a given Client ID

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client-crops read -p client_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 = ["api", "v1 > client-crops > read"]
var params = {
    client_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > client-crops > read"]
params = {
    "client_id": ...,
}
result = client.action(schema, action, params=params)

v1 > client-details > read

GET /api/v1/client-details/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client-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 = ["api", "v1 > client-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("http://127.0.0.1:9015/")

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

v1 > client-pricelist > read

GET /api/v1/client-pricelist/{client_id}/

Using Function CustomerPriceList

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client-pricelist read -p client_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 = ["api", "v1 > client-pricelist > read"]
var params = {
    client_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > client-pricelist > read"]
params = {
    "client_id": ...,
}
result = client.action(schema, action, params=params)

v1 > client-results > read

GET /api/v1/client-results/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 client-results 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 = ["api", "v1 > client-results > 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("http://127.0.0.1:9015/")

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

v1 > clients > list

GET /api/v1/clients/

With clients that the user has access to

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients 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 = ["api", "v1 > clients > 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("http://127.0.0.1:9015/")

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

v1 > clients > create

POST /api/v1/clients/

With clients that the user has access to

Request Body

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

Parameter	Description
`client_id` required
`client_code` required
`physicaladdress` required
`country_id` required
`region_code` required
`client_name` required
`user_portal_access` required
`country_name` required
`lporequired` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients create -p client_id=... -p client_code=... -p physicaladdress=... -p country_id=... -p region_code=... -p client_name=... -p user_portal_access=... -p country_name=... -p lporequired=...

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 = ["api", "v1 > clients > create"]
var params = {
    client_id: ...,
    client_code: ...,
    physicaladdress: ...,
    country_id: ...,
    region_code: ...,
    client_name: ...,
    user_portal_access: ...,
    country_name: ...,
    lporequired: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > clients > create"]
params = {
    "client_id": ...,
    "client_code": ...,
    "physicaladdress": ...,
    "country_id": ...,
    "region_code": ...,
    "client_name": ...,
    "user_portal_access": ...,
    "country_name": ...,
    "lporequired": ...,
}
result = client.action(schema, action, params=params)

v1 > clients > read

GET /api/v1/clients/{client_id}/

With clients that the user has access to

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required	A unique value identifying this Client.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients read -p client_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 = ["api", "v1 > clients > read"]
var params = {
    client_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > clients > read"]
params = {
    "client_id": ...,
}
result = client.action(schema, action, params=params)

v1 > clients > update

PUT /api/v1/clients/{client_id}/

With clients that the user has access to

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required	A unique value identifying this Client.

Request Body

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

Parameter	Description
`client_id` required
`client_code` required
`physicaladdress` required
`country_id` required
`region_code` required
`client_name` required
`user_portal_access` required
`country_name` required
`lporequired` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients update -p client_id=... -p client_id=... -p client_code=... -p physicaladdress=... -p country_id=... -p region_code=... -p client_name=... -p user_portal_access=... -p country_name=... -p lporequired=...

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 = ["api", "v1 > clients > update"]
var params = {
    client_id: ...,
    client_id: ...,
    client_code: ...,
    physicaladdress: ...,
    country_id: ...,
    region_code: ...,
    client_name: ...,
    user_portal_access: ...,
    country_name: ...,
    lporequired: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > clients > update"]
params = {
    "client_id": ...,
    "client_id": ...,
    "client_code": ...,
    "physicaladdress": ...,
    "country_id": ...,
    "region_code": ...,
    "client_name": ...,
    "user_portal_access": ...,
    "country_name": ...,
    "lporequired": ...,
}
result = client.action(schema, action, params=params)

v1 > clients > partial_update

PATCH /api/v1/clients/{client_id}/

With clients that the user has access to

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required	A unique value identifying this Client.

Request Body

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

Parameter	Description
`client_id`
`client_code`
`physicaladdress`
`country_id`
`region_code`
`client_name`
`user_portal_access`
`country_name`
`lporequired`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients partial_update -p client_id=... -p client_id=... -p client_code=... -p physicaladdress=... -p country_id=... -p region_code=... -p client_name=... -p user_portal_access=... -p country_name=... -p lporequired=...

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 = ["api", "v1 > clients > partial_update"]
var params = {
    client_id: ...,
    client_id: ...,
    client_code: ...,
    physicaladdress: ...,
    country_id: ...,
    region_code: ...,
    client_name: ...,
    user_portal_access: ...,
    country_name: ...,
    lporequired: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > clients > partial_update"]
params = {
    "client_id": ...,
    "client_id": ...,
    "client_code": ...,
    "physicaladdress": ...,
    "country_id": ...,
    "region_code": ...,
    "client_name": ...,
    "user_portal_access": ...,
    "country_name": ...,
    "lporequired": ...,
}
result = client.action(schema, action, params=params)

v1 > clients > delete

DELETE /api/v1/clients/{client_id}/

With clients that the user has access to

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`client_id` required	A unique value identifying this Client.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 clients delete -p client_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 = ["api", "v1 > clients > delete"]
var params = {
    client_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > clients > delete"]
params = {
    "client_id": ...,
}
result = client.action(schema, action, params=params)

v1 > contact-details > read

GET /api/v1/contact-details/{id}

ContactDetailsListView allows users to update contact details via PUT requests.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contact-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 = ["api", "v1 > contact-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("http://127.0.0.1:9015/")

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

v1 > contact-details > update

PUT /api/v1/contact-details/{id}

ContactDetailsListView allows users to update contact details via PUT requests.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contact-details update -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 = ["api", "v1 > contact-details > update"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contact-details > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > contacts > list

GET /api/v1/contacts/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts 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 = ["api", "v1 > contacts > 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("http://127.0.0.1:9015/")

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

v1 > contacts > create

POST /api/v1/contacts/

Request Body

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

Parameter	Description
`contact_code`
`owner_code` required
`surname`
`other_names`
`country_id` required
`contact_type` required
`cns_staff` required
`receive_price_list` required
`all_farms` required
`receive_invoice` required
`receive_report` required
`receive_schedule` required
`sms_on_payment` required
`sms_on_analysis_scheduled` required
`sms_on_report_emailed` required
`sms_recommendations` required
`sms_on_batch_login` required
`sms_on_batch_arrival` required
`sms_invoice` required
`email_on_payment` required
`email_on_analysis_scheduled` required
`email_on_report_emailed` required
`email_on_batch_arrival` required
`email_on_invoice` required
`access_all_crops` required
`access_all_sample_types` required
`contact_has_portal_access` required
`phone1`
`phone2`
`email`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts create -p contact_code=... -p owner_code=... -p surname=... -p other_names=... -p country_id=... -p contact_type=... -p cns_staff=... -p receive_price_list=... -p all_farms=... -p receive_invoice=... -p receive_report=... -p receive_schedule=... -p sms_on_payment=... -p sms_on_analysis_scheduled=... -p sms_on_report_emailed=... -p sms_recommendations=... -p sms_on_batch_login=... -p sms_on_batch_arrival=... -p sms_invoice=... -p email_on_payment=... -p email_on_analysis_scheduled=... -p email_on_report_emailed=... -p email_on_batch_arrival=... -p email_on_invoice=... -p access_all_crops=... -p access_all_sample_types=... -p contact_has_portal_access=... -p phone1=... -p phone2=... -p email=...

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 = ["api", "v1 > contacts > create"]
var params = {
    contact_code: ...,
    owner_code: ...,
    surname: ...,
    other_names: ...,
    country_id: ...,
    contact_type: ...,
    cns_staff: ...,
    receive_price_list: ...,
    all_farms: ...,
    receive_invoice: ...,
    receive_report: ...,
    receive_schedule: ...,
    sms_on_payment: ...,
    sms_on_analysis_scheduled: ...,
    sms_on_report_emailed: ...,
    sms_recommendations: ...,
    sms_on_batch_login: ...,
    sms_on_batch_arrival: ...,
    sms_invoice: ...,
    email_on_payment: ...,
    email_on_analysis_scheduled: ...,
    email_on_report_emailed: ...,
    email_on_batch_arrival: ...,
    email_on_invoice: ...,
    access_all_crops: ...,
    access_all_sample_types: ...,
    contact_has_portal_access: ...,
    phone1: ...,
    phone2: ...,
    email: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contacts > create"]
params = {
    "contact_code": ...,
    "owner_code": ...,
    "surname": ...,
    "other_names": ...,
    "country_id": ...,
    "contact_type": ...,
    "cns_staff": ...,
    "receive_price_list": ...,
    "all_farms": ...,
    "receive_invoice": ...,
    "receive_report": ...,
    "receive_schedule": ...,
    "sms_on_payment": ...,
    "sms_on_analysis_scheduled": ...,
    "sms_on_report_emailed": ...,
    "sms_recommendations": ...,
    "sms_on_batch_login": ...,
    "sms_on_batch_arrival": ...,
    "sms_invoice": ...,
    "email_on_payment": ...,
    "email_on_analysis_scheduled": ...,
    "email_on_report_emailed": ...,
    "email_on_batch_arrival": ...,
    "email_on_invoice": ...,
    "access_all_crops": ...,
    "access_all_sample_types": ...,
    "contact_has_portal_access": ...,
    "phone1": ...,
    "phone2": ...,
    "email": ...,
}
result = client.action(schema, action, params=params)

v1 > contacts > read

GET /api/v1/contacts/{contact_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contact_code` required	A unique value identifying this Contact.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts read -p contact_code=...

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 = ["api", "v1 > contacts > read"]
var params = {
    contact_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contacts > read"]
params = {
    "contact_code": ...,
}
result = client.action(schema, action, params=params)

v1 > contacts > update

PUT /api/v1/contacts/{contact_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contact_code` required	A unique value identifying this Contact.

Request Body

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

Parameter	Description
`contact_code`
`owner_code` required
`surname`
`other_names`
`country_id` required
`contact_type` required
`cns_staff` required
`receive_price_list` required
`all_farms` required
`receive_invoice` required
`receive_report` required
`receive_schedule` required
`sms_on_payment` required
`sms_on_analysis_scheduled` required
`sms_on_report_emailed` required
`sms_recommendations` required
`sms_on_batch_login` required
`sms_on_batch_arrival` required
`sms_invoice` required
`email_on_payment` required
`email_on_analysis_scheduled` required
`email_on_report_emailed` required
`email_on_batch_arrival` required
`email_on_invoice` required
`access_all_crops` required
`access_all_sample_types` required
`contact_has_portal_access` required
`phone1`
`phone2`
`email`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts update -p contact_code=... -p contact_code=... -p owner_code=... -p surname=... -p other_names=... -p country_id=... -p contact_type=... -p cns_staff=... -p receive_price_list=... -p all_farms=... -p receive_invoice=... -p receive_report=... -p receive_schedule=... -p sms_on_payment=... -p sms_on_analysis_scheduled=... -p sms_on_report_emailed=... -p sms_recommendations=... -p sms_on_batch_login=... -p sms_on_batch_arrival=... -p sms_invoice=... -p email_on_payment=... -p email_on_analysis_scheduled=... -p email_on_report_emailed=... -p email_on_batch_arrival=... -p email_on_invoice=... -p access_all_crops=... -p access_all_sample_types=... -p contact_has_portal_access=... -p phone1=... -p phone2=... -p email=...

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 = ["api", "v1 > contacts > update"]
var params = {
    contact_code: ...,
    contact_code: ...,
    owner_code: ...,
    surname: ...,
    other_names: ...,
    country_id: ...,
    contact_type: ...,
    cns_staff: ...,
    receive_price_list: ...,
    all_farms: ...,
    receive_invoice: ...,
    receive_report: ...,
    receive_schedule: ...,
    sms_on_payment: ...,
    sms_on_analysis_scheduled: ...,
    sms_on_report_emailed: ...,
    sms_recommendations: ...,
    sms_on_batch_login: ...,
    sms_on_batch_arrival: ...,
    sms_invoice: ...,
    email_on_payment: ...,
    email_on_analysis_scheduled: ...,
    email_on_report_emailed: ...,
    email_on_batch_arrival: ...,
    email_on_invoice: ...,
    access_all_crops: ...,
    access_all_sample_types: ...,
    contact_has_portal_access: ...,
    phone1: ...,
    phone2: ...,
    email: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contacts > update"]
params = {
    "contact_code": ...,
    "contact_code": ...,
    "owner_code": ...,
    "surname": ...,
    "other_names": ...,
    "country_id": ...,
    "contact_type": ...,
    "cns_staff": ...,
    "receive_price_list": ...,
    "all_farms": ...,
    "receive_invoice": ...,
    "receive_report": ...,
    "receive_schedule": ...,
    "sms_on_payment": ...,
    "sms_on_analysis_scheduled": ...,
    "sms_on_report_emailed": ...,
    "sms_recommendations": ...,
    "sms_on_batch_login": ...,
    "sms_on_batch_arrival": ...,
    "sms_invoice": ...,
    "email_on_payment": ...,
    "email_on_analysis_scheduled": ...,
    "email_on_report_emailed": ...,
    "email_on_batch_arrival": ...,
    "email_on_invoice": ...,
    "access_all_crops": ...,
    "access_all_sample_types": ...,
    "contact_has_portal_access": ...,
    "phone1": ...,
    "phone2": ...,
    "email": ...,
}
result = client.action(schema, action, params=params)

v1 > contacts > partial_update

PATCH /api/v1/contacts/{contact_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contact_code` required	A unique value identifying this Contact.

Request Body

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

Parameter	Description
`contact_code`
`owner_code`
`surname`
`other_names`
`country_id`
`contact_type`
`cns_staff`
`receive_price_list`
`all_farms`
`receive_invoice`
`receive_report`
`receive_schedule`
`sms_on_payment`
`sms_on_analysis_scheduled`
`sms_on_report_emailed`
`sms_recommendations`
`sms_on_batch_login`
`sms_on_batch_arrival`
`sms_invoice`
`email_on_payment`
`email_on_analysis_scheduled`
`email_on_report_emailed`
`email_on_batch_arrival`
`email_on_invoice`
`access_all_crops`
`access_all_sample_types`
`contact_has_portal_access`
`phone1`
`phone2`
`email`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts partial_update -p contact_code=... -p contact_code=... -p owner_code=... -p surname=... -p other_names=... -p country_id=... -p contact_type=... -p cns_staff=... -p receive_price_list=... -p all_farms=... -p receive_invoice=... -p receive_report=... -p receive_schedule=... -p sms_on_payment=... -p sms_on_analysis_scheduled=... -p sms_on_report_emailed=... -p sms_recommendations=... -p sms_on_batch_login=... -p sms_on_batch_arrival=... -p sms_invoice=... -p email_on_payment=... -p email_on_analysis_scheduled=... -p email_on_report_emailed=... -p email_on_batch_arrival=... -p email_on_invoice=... -p access_all_crops=... -p access_all_sample_types=... -p contact_has_portal_access=... -p phone1=... -p phone2=... -p email=...

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 = ["api", "v1 > contacts > partial_update"]
var params = {
    contact_code: ...,
    contact_code: ...,
    owner_code: ...,
    surname: ...,
    other_names: ...,
    country_id: ...,
    contact_type: ...,
    cns_staff: ...,
    receive_price_list: ...,
    all_farms: ...,
    receive_invoice: ...,
    receive_report: ...,
    receive_schedule: ...,
    sms_on_payment: ...,
    sms_on_analysis_scheduled: ...,
    sms_on_report_emailed: ...,
    sms_recommendations: ...,
    sms_on_batch_login: ...,
    sms_on_batch_arrival: ...,
    sms_invoice: ...,
    email_on_payment: ...,
    email_on_analysis_scheduled: ...,
    email_on_report_emailed: ...,
    email_on_batch_arrival: ...,
    email_on_invoice: ...,
    access_all_crops: ...,
    access_all_sample_types: ...,
    contact_has_portal_access: ...,
    phone1: ...,
    phone2: ...,
    email: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contacts > partial_update"]
params = {
    "contact_code": ...,
    "contact_code": ...,
    "owner_code": ...,
    "surname": ...,
    "other_names": ...,
    "country_id": ...,
    "contact_type": ...,
    "cns_staff": ...,
    "receive_price_list": ...,
    "all_farms": ...,
    "receive_invoice": ...,
    "receive_report": ...,
    "receive_schedule": ...,
    "sms_on_payment": ...,
    "sms_on_analysis_scheduled": ...,
    "sms_on_report_emailed": ...,
    "sms_recommendations": ...,
    "sms_on_batch_login": ...,
    "sms_on_batch_arrival": ...,
    "sms_invoice": ...,
    "email_on_payment": ...,
    "email_on_analysis_scheduled": ...,
    "email_on_report_emailed": ...,
    "email_on_batch_arrival": ...,
    "email_on_invoice": ...,
    "access_all_crops": ...,
    "access_all_sample_types": ...,
    "contact_has_portal_access": ...,
    "phone1": ...,
    "phone2": ...,
    "email": ...,
}
result = client.action(schema, action, params=params)

v1 > contacts > delete

DELETE /api/v1/contacts/{contact_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`contact_code` required	A unique value identifying this Contact.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 contacts delete -p contact_code=...

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 = ["api", "v1 > contacts > delete"]
var params = {
    contact_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > contacts > delete"]
params = {
    "contact_code": ...,
}
result = client.action(schema, action, params=params)

v1 > countries > list

GET /api/v1/countries/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 countries 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 = ["api", "v1 > countries > 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("http://127.0.0.1:9015/")

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

v1 > create-batch > create

POST /api/v1/create-batch/

Request Body

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

Parameter	Description
`batch_date` required
`group_code` required
`client_id` required
`farm_code` required
`ref_no`
`bill_ref_number`
`amount`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 create-batch create -p batch_date=... -p group_code=... -p client_id=... -p farm_code=... -p ref_no=... -p bill_ref_number=... -p amount=...

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 = ["api", "v1 > create-batch > create"]
var params = {
    batch_date: ...,
    group_code: ...,
    client_id: ...,
    farm_code: ...,
    ref_no: ...,
    bill_ref_number: ...,
    amount: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > create-batch > create"]
params = {
    "batch_date": ...,
    "group_code": ...,
    "client_id": ...,
    "farm_code": ...,
    "ref_no": ...,
    "bill_ref_number": ...,
    "amount": ...,
}
result = client.action(schema, action, params=params)

v1 > create-farm > create

POST /api/v1/create-farm/

Request Body

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

Parameter	Description
`client_id` required
`farm_name` required
`phone` required
`postal_address` required
`physical_address` required
`email` required
`country_id` required
`salesregion_code` required
`crop_codes`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 create-farm create -p client_id=... -p farm_name=... -p phone=... -p postal_address=... -p physical_address=... -p email=... -p country_id=... -p salesregion_code=... -p crop_codes=...

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 = ["api", "v1 > create-farm > create"]
var params = {
    client_id: ...,
    farm_name: ...,
    phone: ...,
    postal_address: ...,
    physical_address: ...,
    email: ...,
    country_id: ...,
    salesregion_code: ...,
    crop_codes: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > create-farm > create"]
params = {
    "client_id": ...,
    "farm_name": ...,
    "phone": ...,
    "postal_address": ...,
    "physical_address": ...,
    "email": ...,
    "country_id": ...,
    "salesregion_code": ...,
    "crop_codes": ...,
}
result = client.action(schema, action, params=params)

v1 > create-sample > create

POST /api/v1/create-sample/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 create-sample 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 = ["api", "v1 > create-sample > 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("http://127.0.0.1:9015/")

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

v1 > create-watersource > create

POST /api/v1/create-watersource/

Request Body

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

Parameter	Description
`source_name` required
`farm_code` required
`latitude`
`longitude`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 create-watersource create -p source_name=... -p farm_code=... -p latitude=... -p longitude=...

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 = ["api", "v1 > create-watersource > create"]
var params = {
    source_name: ...,
    farm_code: ...,
    latitude: ...,
    longitude: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > create-watersource > create"]
params = {
    "source_name": ...,
    "farm_code": ...,
    "latitude": ...,
    "longitude": ...,
}
result = client.action(schema, action, params=params)

v1 > crop > growth-stages > list

GET /api/v1/crop/{id}/growth-stages/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crop growth-stages list -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 = ["api", "v1 > crop > growth-stages > list"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crop > growth-stages > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > crops > list

GET /api/v1/crops/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops 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 = ["api", "v1 > crops > 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("http://127.0.0.1:9015/")

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

v1 > crops > list_0

GET /api/v1/crops/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops list_0

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 = ["api", "v1 > crops > list_0"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > list_0"]
result = client.action(schema, action)

v1 > crops > create

POST /api/v1/crops/

Request Body

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

Parameter	Description
`crop_code` required
`crop_name`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops create -p crop_code=... -p crop_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 = ["api", "v1 > crops > create"]
var params = {
    crop_code: ...,
    crop_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > create"]
params = {
    "crop_code": ...,
    "crop_name": ...,
}
result = client.action(schema, action, params=params)

v1 > crops > read

GET /api/v1/crops/{crop_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`crop_code` required	A unique value identifying this Crop.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops read -p crop_code=...

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 = ["api", "v1 > crops > read"]
var params = {
    crop_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > read"]
params = {
    "crop_code": ...,
}
result = client.action(schema, action, params=params)

v1 > crops > update

PUT /api/v1/crops/{crop_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`crop_code` required	A unique value identifying this Crop.

Request Body

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

Parameter	Description
`crop_code` required
`crop_name`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops update -p crop_code=... -p crop_code=... -p crop_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 = ["api", "v1 > crops > update"]
var params = {
    crop_code: ...,
    crop_code: ...,
    crop_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > update"]
params = {
    "crop_code": ...,
    "crop_code": ...,
    "crop_name": ...,
}
result = client.action(schema, action, params=params)

v1 > crops > partial_update

PATCH /api/v1/crops/{crop_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`crop_code` required	A unique value identifying this Crop.

Request Body

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

Parameter	Description
`crop_code`
`crop_name`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops partial_update -p crop_code=... -p crop_code=... -p crop_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 = ["api", "v1 > crops > partial_update"]
var params = {
    crop_code: ...,
    crop_code: ...,
    crop_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > partial_update"]
params = {
    "crop_code": ...,
    "crop_code": ...,
    "crop_name": ...,
}
result = client.action(schema, action, params=params)

v1 > crops > delete

DELETE /api/v1/crops/{crop_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`crop_code` required	A unique value identifying this Crop.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 crops delete -p crop_code=...

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 = ["api", "v1 > crops > delete"]
var params = {
    crop_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > crops > delete"]
params = {
    "crop_code": ...,
}
result = client.action(schema, action, params=params)

v1 > download > read

GET /api/v1/download/{batch_code}/{type}

Fetch report by barcode

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required
`type` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 download read -p batch_code=... -p type=...

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 = ["api", "v1 > download > read"]
var params = {
    batch_code: ...,
    type: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > download > read"]
params = {
    "batch_code": ...,
    "type": ...,
}
result = client.action(schema, action, params=params)

v1 > farm > batches > list

GET /api/v1/farm/{id}/batches/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 farm batches list -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 = ["api", "v1 > farm > batches > list"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > farm > batches > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > farm > fields > list

GET /api/v1/farm/{id}/fields/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 farm fields list -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 = ["api", "v1 > farm > fields > list"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > farm > fields > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > farm > watersources > list

GET /api/v1/farm/{id}/watersources/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 farm watersources list -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 = ["api", "v1 > farm > watersources > list"]
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > farm > watersources > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

v1 > farm-crops > read

GET /api/v1/farm-crops/{farm_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`farm_code` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 farm-crops read -p farm_code=...

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 = ["api", "v1 > farm-crops > read"]
var params = {
    farm_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > farm-crops > read"]
params = {
    "farm_code": ...,
}
result = client.action(schema, action, params=params)

v1 > farms > list

GET /api/v1/farms/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 farms 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 = ["api", "v1 > farms > 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("http://127.0.0.1:9015/")

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

v1 > fertilizer > list

GET /api/v1/fertilizer/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 fertilizer 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 = ["api", "v1 > fertilizer > 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("http://127.0.0.1:9015/")

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

v1 > fields > create

POST /api/v1/fields/

Request Body

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

Parameter	Description
`field_name` required
`farm_code` required
`field_boundary` required
`field_size_acres`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 fields create -p field_name=... -p farm_code=... -p field_boundary=... -p field_size_acres=...

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 = ["api", "v1 > fields > create"]
var params = {
    field_name: ...,
    farm_code: ...,
    field_boundary: ...,
    field_size_acres: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > fields > create"]
params = {
    "field_name": ...,
    "farm_code": ...,
    "field_boundary": ...,
    "field_size_acres": ...,
}
result = client.action(schema, action, params=params)

v1 > sample-conditions > list

GET /api/v1/sample-conditions/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sample-conditions 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 = ["api", "v1 > sample-conditions > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sample-conditions > list"]
result = client.action(schema, action)

v1 > sample-depth > list

GET /api/v1/sample-depth/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sample-depth 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 = ["api", "v1 > sample-depth > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sample-depth > list"]
result = client.action(schema, action)

v1 > sampledetails > list

GET /api/v1/sampledetails/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails 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 = ["api", "v1 > sampledetails > 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("http://127.0.0.1:9015/")

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

v1 > sampledetails > create

POST /api/v1/sampledetails/

Request Body

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

Parameter	Description
`sampledt_code` required
`analysisdt_code`
`guide`
`result`
`comments`
`recheck`
`guide_low`
`guide_high`
`unit_code`
`status_code`
`result_symbol`
`qc`
`corrected_target`
`standard_target`
`recommendations`
`initial_result`
`initial_result_symbol`
`very_low_guide`
`very_high_guide`
`sample` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails create -p sampledt_code=... -p analysisdt_code=... -p guide=... -p result=... -p comments=... -p recheck=... -p guide_low=... -p guide_high=... -p unit_code=... -p status_code=... -p result_symbol=... -p qc=... -p corrected_target=... -p standard_target=... -p recommendations=... -p initial_result=... -p initial_result_symbol=... -p very_low_guide=... -p very_high_guide=... -p sample=...

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 = ["api", "v1 > sampledetails > create"]
var params = {
    sampledt_code: ...,
    analysisdt_code: ...,
    guide: ...,
    result: ...,
    comments: ...,
    recheck: ...,
    guide_low: ...,
    guide_high: ...,
    unit_code: ...,
    status_code: ...,
    result_symbol: ...,
    qc: ...,
    corrected_target: ...,
    standard_target: ...,
    recommendations: ...,
    initial_result: ...,
    initial_result_symbol: ...,
    very_low_guide: ...,
    very_high_guide: ...,
    sample: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sampledetails > create"]
params = {
    "sampledt_code": ...,
    "analysisdt_code": ...,
    "guide": ...,
    "result": ...,
    "comments": ...,
    "recheck": ...,
    "guide_low": ...,
    "guide_high": ...,
    "unit_code": ...,
    "status_code": ...,
    "result_symbol": ...,
    "qc": ...,
    "corrected_target": ...,
    "standard_target": ...,
    "recommendations": ...,
    "initial_result": ...,
    "initial_result_symbol": ...,
    "very_low_guide": ...,
    "very_high_guide": ...,
    "sample": ...,
}
result = client.action(schema, action, params=params)

v1 > sampledetails > read

GET /api/v1/sampledetails/{sampledt_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`sampledt_code` required	A unique value identifying this Sample Details.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails read -p sampledt_code=...

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 = ["api", "v1 > sampledetails > read"]
var params = {
    sampledt_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sampledetails > read"]
params = {
    "sampledt_code": ...,
}
result = client.action(schema, action, params=params)

v1 > sampledetails > update

PUT /api/v1/sampledetails/{sampledt_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`sampledt_code` required	A unique value identifying this Sample Details.

Request Body

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

Parameter	Description
`sampledt_code` required
`analysisdt_code`
`guide`
`result`
`comments`
`recheck`
`guide_low`
`guide_high`
`unit_code`
`status_code`
`result_symbol`
`qc`
`corrected_target`
`standard_target`
`recommendations`
`initial_result`
`initial_result_symbol`
`very_low_guide`
`very_high_guide`
`sample` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails update -p sampledt_code=... -p sampledt_code=... -p analysisdt_code=... -p guide=... -p result=... -p comments=... -p recheck=... -p guide_low=... -p guide_high=... -p unit_code=... -p status_code=... -p result_symbol=... -p qc=... -p corrected_target=... -p standard_target=... -p recommendations=... -p initial_result=... -p initial_result_symbol=... -p very_low_guide=... -p very_high_guide=... -p sample=...

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 = ["api", "v1 > sampledetails > update"]
var params = {
    sampledt_code: ...,
    sampledt_code: ...,
    analysisdt_code: ...,
    guide: ...,
    result: ...,
    comments: ...,
    recheck: ...,
    guide_low: ...,
    guide_high: ...,
    unit_code: ...,
    status_code: ...,
    result_symbol: ...,
    qc: ...,
    corrected_target: ...,
    standard_target: ...,
    recommendations: ...,
    initial_result: ...,
    initial_result_symbol: ...,
    very_low_guide: ...,
    very_high_guide: ...,
    sample: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sampledetails > update"]
params = {
    "sampledt_code": ...,
    "sampledt_code": ...,
    "analysisdt_code": ...,
    "guide": ...,
    "result": ...,
    "comments": ...,
    "recheck": ...,
    "guide_low": ...,
    "guide_high": ...,
    "unit_code": ...,
    "status_code": ...,
    "result_symbol": ...,
    "qc": ...,
    "corrected_target": ...,
    "standard_target": ...,
    "recommendations": ...,
    "initial_result": ...,
    "initial_result_symbol": ...,
    "very_low_guide": ...,
    "very_high_guide": ...,
    "sample": ...,
}
result = client.action(schema, action, params=params)

v1 > sampledetails > partial_update

PATCH /api/v1/sampledetails/{sampledt_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`sampledt_code` required	A unique value identifying this Sample Details.

Request Body

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

Parameter	Description
`sampledt_code`
`analysisdt_code`
`guide`
`result`
`comments`
`recheck`
`guide_low`
`guide_high`
`unit_code`
`status_code`
`result_symbol`
`qc`
`corrected_target`
`standard_target`
`recommendations`
`initial_result`
`initial_result_symbol`
`very_low_guide`
`very_high_guide`
`sample`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails partial_update -p sampledt_code=... -p sampledt_code=... -p analysisdt_code=... -p guide=... -p result=... -p comments=... -p recheck=... -p guide_low=... -p guide_high=... -p unit_code=... -p status_code=... -p result_symbol=... -p qc=... -p corrected_target=... -p standard_target=... -p recommendations=... -p initial_result=... -p initial_result_symbol=... -p very_low_guide=... -p very_high_guide=... -p sample=...

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 = ["api", "v1 > sampledetails > partial_update"]
var params = {
    sampledt_code: ...,
    sampledt_code: ...,
    analysisdt_code: ...,
    guide: ...,
    result: ...,
    comments: ...,
    recheck: ...,
    guide_low: ...,
    guide_high: ...,
    unit_code: ...,
    status_code: ...,
    result_symbol: ...,
    qc: ...,
    corrected_target: ...,
    standard_target: ...,
    recommendations: ...,
    initial_result: ...,
    initial_result_symbol: ...,
    very_low_guide: ...,
    very_high_guide: ...,
    sample: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sampledetails > partial_update"]
params = {
    "sampledt_code": ...,
    "sampledt_code": ...,
    "analysisdt_code": ...,
    "guide": ...,
    "result": ...,
    "comments": ...,
    "recheck": ...,
    "guide_low": ...,
    "guide_high": ...,
    "unit_code": ...,
    "status_code": ...,
    "result_symbol": ...,
    "qc": ...,
    "corrected_target": ...,
    "standard_target": ...,
    "recommendations": ...,
    "initial_result": ...,
    "initial_result_symbol": ...,
    "very_low_guide": ...,
    "very_high_guide": ...,
    "sample": ...,
}
result = client.action(schema, action, params=params)

v1 > sampledetails > delete

DELETE /api/v1/sampledetails/{sampledt_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`sampledt_code` required	A unique value identifying this Sample Details.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 sampledetails delete -p sampledt_code=...

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 = ["api", "v1 > sampledetails > delete"]
var params = {
    sampledt_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > sampledetails > delete"]
params = {
    "sampledt_code": ...,
}
result = client.action(schema, action, params=params)

v1 > samples > create > create

POST /api/v1/samples/create/

Request Body

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

Parameter	Description
`batch_code`
`sample_code`
`field_code`
`source_code`
`crop_code`
`crop_code2`
`location` required
`depth_code`
`crop_codes`
`additional_crops`
`comments`
`sample_name`
`client_id` required
`group_code` required
`sample_condition`
`sample_barcode`
`analysis_ids` required
`growth_code`
`previous_crop` required
`next_crop` required
`ward_id`
`tree_crop`
`tree_population`
`date_of_planting`
`previous_yield`
`farmer_code`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 samples create create -p batch_code=... -p sample_code=... -p field_code=... -p source_code=... -p crop_code=... -p crop_code2=... -p location=... -p depth_code=... -p crop_codes=... -p additional_crops=... -p comments=... -p sample_name=... -p client_id=... -p group_code=... -p sample_condition=... -p sample_barcode=... -p analysis_ids=... -p growth_code=... -p previous_crop=... -p next_crop=... -p ward_id=... -p tree_crop=... -p tree_population=... -p date_of_planting=... -p previous_yield=... -p farmer_code=...

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 = ["api", "v1 > samples > create > create"]
var params = {
    batch_code: ...,
    sample_code: ...,
    field_code: ...,
    source_code: ...,
    crop_code: ...,
    crop_code2: ...,
    location: ...,
    depth_code: ...,
    crop_codes: ...,
    additional_crops: ...,
    comments: ...,
    sample_name: ...,
    client_id: ...,
    group_code: ...,
    sample_condition: ...,
    sample_barcode: ...,
    analysis_ids: ...,
    growth_code: ...,
    previous_crop: ...,
    next_crop: ...,
    ward_id: ...,
    tree_crop: ...,
    tree_population: ...,
    date_of_planting: ...,
    previous_yield: ...,
    farmer_code: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > samples > create > create"]
params = {
    "batch_code": ...,
    "sample_code": ...,
    "field_code": ...,
    "source_code": ...,
    "crop_code": ...,
    "crop_code2": ...,
    "location": ...,
    "depth_code": ...,
    "crop_codes": ...,
    "additional_crops": ...,
    "comments": ...,
    "sample_name": ...,
    "client_id": ...,
    "group_code": ...,
    "sample_condition": ...,
    "sample_barcode": ...,
    "analysis_ids": ...,
    "growth_code": ...,
    "previous_crop": ...,
    "next_crop": ...,
    "ward_id": ...,
    "tree_crop": ...,
    "tree_population": ...,
    "date_of_planting": ...,
    "previous_yield": ...,
    "farmer_code": ...,
}
result = client.action(schema, action, params=params)

v1 > update-amount > partial_update

PATCH /api/v1/update-amount/{batch_code}/

Updates the amount to be paid for the batch

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`batch_code` required

Request Body

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

Parameter	Description
`amount` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-amount partial_update -p batch_code=... -p amount=...

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 = ["api", "v1 > update-amount > partial_update"]
var params = {
    batch_code: ...,
    amount: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-amount > partial_update"]
params = {
    "batch_code": ...,
    "amount": ...,
}
result = client.action(schema, action, params=params)

v1 > update-farm > update

PUT /api/v1/update-farm/{farm_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`farm_code` required	A unique value identifying this Farm.

Request Body

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

Parameter	Description
`farm_code` required
`client_id`
`sector_code` required
`farm_name`
`postaladdress`
`physicaladdress`
`email`
`phone1`
`website`
`salesregion_code`
`country_id` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-farm update -p farm_code=... -p farm_code=... -p client_id=... -p sector_code=... -p farm_name=... -p postaladdress=... -p physicaladdress=... -p email=... -p phone1=... -p website=... -p salesregion_code=... -p country_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 = ["api", "v1 > update-farm > update"]
var params = {
    farm_code: ...,
    farm_code: ...,
    client_id: ...,
    sector_code: ...,
    farm_name: ...,
    postaladdress: ...,
    physicaladdress: ...,
    email: ...,
    phone1: ...,
    website: ...,
    salesregion_code: ...,
    country_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-farm > update"]
params = {
    "farm_code": ...,
    "farm_code": ...,
    "client_id": ...,
    "sector_code": ...,
    "farm_name": ...,
    "postaladdress": ...,
    "physicaladdress": ...,
    "email": ...,
    "phone1": ...,
    "website": ...,
    "salesregion_code": ...,
    "country_id": ...,
}
result = client.action(schema, action, params=params)

v1 > update-farm > partial_update

PATCH /api/v1/update-farm/{farm_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`farm_code` required	A unique value identifying this Farm.

Request Body

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

Parameter	Description
`farm_code`
`client_id`
`sector_code`
`farm_name`
`postaladdress`
`physicaladdress`
`email`
`phone1`
`website`
`salesregion_code`
`country_id`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-farm partial_update -p farm_code=... -p farm_code=... -p client_id=... -p sector_code=... -p farm_name=... -p postaladdress=... -p physicaladdress=... -p email=... -p phone1=... -p website=... -p salesregion_code=... -p country_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 = ["api", "v1 > update-farm > partial_update"]
var params = {
    farm_code: ...,
    farm_code: ...,
    client_id: ...,
    sector_code: ...,
    farm_name: ...,
    postaladdress: ...,
    physicaladdress: ...,
    email: ...,
    phone1: ...,
    website: ...,
    salesregion_code: ...,
    country_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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-farm > partial_update"]
params = {
    "farm_code": ...,
    "farm_code": ...,
    "client_id": ...,
    "sector_code": ...,
    "farm_name": ...,
    "postaladdress": ...,
    "physicaladdress": ...,
    "email": ...,
    "phone1": ...,
    "website": ...,
    "salesregion_code": ...,
    "country_id": ...,
}
result = client.action(schema, action, params=params)

v1 > update-field > update

PUT /api/v1/update-field/{field_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`field_code` required	A unique value identifying this Field.

Request Body

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

Parameter	Description
`field_code`
`field_name`
`farm_code`
`tree_crop`
`date_of_planting`
`fieldboundary`
`field_size_acres`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-field update -p field_code=... -p field_code=... -p field_name=... -p farm_code=... -p tree_crop=... -p date_of_planting=... -p fieldboundary=... -p field_size_acres=...

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 = ["api", "v1 > update-field > update"]
var params = {
    field_code: ...,
    field_code: ...,
    field_name: ...,
    farm_code: ...,
    tree_crop: ...,
    date_of_planting: ...,
    fieldboundary: ...,
    field_size_acres: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-field > update"]
params = {
    "field_code": ...,
    "field_code": ...,
    "field_name": ...,
    "farm_code": ...,
    "tree_crop": ...,
    "date_of_planting": ...,
    "fieldboundary": ...,
    "field_size_acres": ...,
}
result = client.action(schema, action, params=params)

v1 > update-field > partial_update

PATCH /api/v1/update-field/{field_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`field_code` required	A unique value identifying this Field.

Request Body

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

Parameter	Description
`field_code`
`field_name`
`farm_code`
`tree_crop`
`date_of_planting`
`fieldboundary`
`field_size_acres`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-field partial_update -p field_code=... -p field_code=... -p field_name=... -p farm_code=... -p tree_crop=... -p date_of_planting=... -p fieldboundary=... -p field_size_acres=...

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 = ["api", "v1 > update-field > partial_update"]
var params = {
    field_code: ...,
    field_code: ...,
    field_name: ...,
    farm_code: ...,
    tree_crop: ...,
    date_of_planting: ...,
    fieldboundary: ...,
    field_size_acres: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-field > partial_update"]
params = {
    "field_code": ...,
    "field_code": ...,
    "field_name": ...,
    "farm_code": ...,
    "tree_crop": ...,
    "date_of_planting": ...,
    "fieldboundary": ...,
    "field_size_acres": ...,
}
result = client.action(schema, action, params=params)

v1 > update-watersource > update

PUT /api/v1/update-watersource/{source_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`source_code` required	A unique value identifying this Water Sources.

Request Body

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

Parameter	Description
`source_code` required
`source_name`
`farm_code`
`latitude` required
`longitude` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-watersource update -p source_code=... -p source_code=... -p source_name=... -p farm_code=... -p latitude=... -p longitude=...

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 = ["api", "v1 > update-watersource > update"]
var params = {
    source_code: ...,
    source_code: ...,
    source_name: ...,
    farm_code: ...,
    latitude: ...,
    longitude: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-watersource > update"]
params = {
    "source_code": ...,
    "source_code": ...,
    "source_name": ...,
    "farm_code": ...,
    "latitude": ...,
    "longitude": ...,
}
result = client.action(schema, action, params=params)

v1 > update-watersource > partial_update

PATCH /api/v1/update-watersource/{source_code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`source_code` required	A unique value identifying this Water Sources.

Request Body

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

Parameter	Description
`source_code`
`source_name`
`farm_code`
`latitude`
`longitude`

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 update-watersource partial_update -p source_code=... -p source_code=... -p source_name=... -p farm_code=... -p latitude=... -p longitude=...

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 = ["api", "v1 > update-watersource > partial_update"]
var params = {
    source_code: ...,
    source_code: ...,
    source_name: ...,
    farm_code: ...,
    latitude: ...,
    longitude: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > update-watersource > partial_update"]
params = {
    "source_code": ...,
    "source_code": ...,
    "source_name": ...,
    "farm_code": ...,
    "latitude": ...,
    "longitude": ...,
}
result = client.action(schema, action, params=params)

v1 > users > list

GET /api/v1/users/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 users 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 = ["api", "v1 > users > 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("http://127.0.0.1:9015/")

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

v1 > water-use > list

GET /api/v1/water-use/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 water-use 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 = ["api", "v1 > water-use > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["api", "v1 > water-use > list"]
result = client.action(schema, action)

v1 > watersources > list

GET /api/v1/watersources/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action api v1 watersources 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 = ["api", "v1 > watersources > 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("http://127.0.0.1:9015/")

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

finanicial-dahboards

list

GET /finanicial-dahboards/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action finanicial-dahboards 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 = ["finanicial-dahboards", "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("http://127.0.0.1:9015/")

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

create

POST /finanicial-dahboards/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action finanicial-dahboards 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 = ["finanicial-dahboards", "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("http://127.0.0.1:9015/")

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

getbase64

list

GET /getbase64/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action getbase64 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 = ["getbase64", "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("http://127.0.0.1:9015/")

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

handle_json

list

GET /handle_json/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action handle_json 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 = ["handle_json", "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("http://127.0.0.1:9015/")

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

create

POST /handle_json/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action handle_json 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 = ["handle_json", "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("http://127.0.0.1:9015/")

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

me

list

GET /me/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action me 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 = ["me", "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("http://127.0.0.1:9015/")

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

create

POST /me/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action me 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 = ["me", "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("http://127.0.0.1:9015/")

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

user

list

GET /user/

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user 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 = ["user", "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("http://127.0.0.1:9015/")

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

app-version > list

GET /user/app-version/

Returns current app version code

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user app-version 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 = ["user", "app-version > 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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["user", "app-version > list"]
result = client.action(schema, action)

POST /user/login/

Request Body

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

Parameter	Description
`email` required
`password` required

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user login create -p email=... -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 = ["user", "login > create"]
var params = {
    email: ...,
    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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["user", "login > create"]
params = {
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

logout > list

GET /user/logout/

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user logout 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 = ["user", "logout > 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("http://127.0.0.1:9015/")

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

logout > create

POST /user/logout/

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user logout 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 = ["user", "logout > 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("http://127.0.0.1:9015/")

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

password-change > create

POST /user/password-change/

Request Body

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

Parameter	Description
`old_password` required	Enter old password
`new_password1` required	Enter new password
`new_password2` required	Confirm new password

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user password-change create -p old_password=... -p new_password1=... -p new_password2=...

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 = ["user", "password-change > create"]
var params = {
    old_password: ...,
    new_password1: ...,
    new_password2: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["user", "password-change > create"]
params = {
    "old_password": ...,
    "new_password1": ...,
    "new_password2": ...,
}
result = client.action(schema, action, params=params)

password-reset > create

POST /user/password-reset/

Request Body

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

Parameter	Description
`new_password1` required	Enter new password
`new_password2` required	Confirm new password

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user password-reset create -p new_password1=... -p new_password2=...

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 = ["user", "password-reset > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
}
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("http://127.0.0.1:9015/")

# Interact with the API endpoint
action = ["user", "password-reset > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
}
result = client.action(schema, action, params=params)

password-reset > verify-code > create

POST /user/password-reset/verify-code/

Request Body

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

Parameter	Description
`code` required	4 digit code sent via email

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user password-reset verify-code create -p code=...

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 = ["user", "password-reset > verify-code > create"]
var params = {
    code: ...,
}
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("http://127.0.0.1:9015/")

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

password-reset > verify-email > create

POST /user/password-reset/verify-email/

Request Body

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

Parameter	Description
`email` required	Valid email address

# Load the schema document
$ coreapi get http://127.0.0.1:9015/

# Interact with the API endpoint
$ coreapi action user password-reset verify-email create -p email=...

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 = ["user", "password-reset > verify-email > create"]
var params = {
    email: ...,
}
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("http://127.0.0.1:9015/")

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