Scan Harvest API

Farm Block

Endpoint:http://localhost:8000/api/v1

Get blocks

GET

http://localhost:8000/api/v1

/farms/{farm_id}/blocks

Get all blocks in a farm

Get blocks › path Parameters

farm_idstring · required
Farm ID

Get blocks › Responses

List of blocks

block_idstring
farm_idstring
namestring
noteobject

Create a new block

POST

http://localhost:8000/api/v1

/farms/{farm_id}/blocks

Create a new block in a farm

Create a new block › path Parameters

farm_idstring · required
Farm ID

Create a new block › Request Body

namestring
notestring

Create a new block › Responses

Block created successfully

data
errorsobject
infoobject
request_idstring

Delete a block

DELETE

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/{block_id}

Delete a block by ID

Delete a block › path Parameters

farm_idstring · required
Farm ID
block_idstring · required
Block ID

Delete a block › Request Body

notestring

Delete a block › Responses

Block deleted successfully

data
errorsobject
infoobject
request_idstring

Update a block

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/{block_id}

Update a block's details

Update a block › path Parameters

farm_idstring · required
Farm ID
block_idstring · required
Block ID

Update a block › Request Body

namestring
notestring

Update a block › Responses

Block updated successfully

data
errorsobject
infoobject
request_idstring

Merge two blocks

POST

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/merge

Merge an old block into a new block

Merge two blocks › path Parameters

farm_idstring · required
Farm ID

Merge two blocks › Request Body

new_block_idstring
notestring
old_block_idstring

Merge two blocks › Responses

Block merged successfully

data
errorsobject
infoobject
request_idstring

Attendance Dashboard

Scan Harvest API

Farm Block

Endpoint:http://localhost:8000/api/v1

Get blocks

GET

http://localhost:8000/api/v1

/farms/{farm_id}/blocks

Get all blocks in a farm

Get blocks › path Parameters

farm_idstring · required
Farm ID

Get blocks › Responses

List of blocks

block_idstring
farm_idstring
namestring
noteobject

Create a new block

POST

http://localhost:8000/api/v1

/farms/{farm_id}/blocks

Create a new block in a farm

Create a new block › path Parameters

farm_idstring · required
Farm ID

Create a new block › Request Body

namestring
notestring

Create a new block › Responses

Block created successfully

data
errorsobject
infoobject
request_idstring

Delete a block

DELETE

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/{block_id}

Delete a block by ID

Delete a block › path Parameters

farm_idstring · required
Farm ID
block_idstring · required
Block ID

Delete a block › Request Body

notestring

Delete a block › Responses

Block deleted successfully

data
errorsobject
infoobject
request_idstring

Update a block

PATCH

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/{block_id}

Update a block's details

Update a block › path Parameters

farm_idstring · required
Farm ID
block_idstring · required
Block ID

Update a block › Request Body

namestring
notestring

Update a block › Responses

Block updated successfully

data
errorsobject
infoobject
request_idstring

Merge two blocks

POST

http://localhost:8000/api/v1

/farms/{farm_id}/blocks/merge

Merge an old block into a new block

Merge two blocks › path Parameters

farm_idstring · required
Farm ID

Merge two blocks › Request Body

new_block_idstring
notestring
old_block_idstring

Merge two blocks › Responses

Block merged successfully

data
errorsobject
infoobject
request_idstring

Attendance Dashboard