Basic APIs
Create Farmer Endpoint
Trace Connect APIs
- Introduction
- Authentication using JWT
- OAuth 2.0
- Basic APIs
- Advanced APIs
Basic APIs
Create Farmer Endpoint
This API endpoint allows you to seamlessly integrate and create a new submission for farmers within the supply chain system. Through this endpoint, you can capture essential information about farmers, including entity card details, form submissions, contact information, and additional demographic data.
POST
/
supply-chains
/
farmers
curl --request POST \
--url http://localhost:3000/connect/v1/supply-chains/farmers/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"value": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>",
"form": "<string>",
"product": "<string>"
},
"phone": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}'
{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"value": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>",
"form": "<string>",
"product": "<string>"
},
"phone": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}
Authorizations
Body
application/json
Response
201 - application/json
The response is of type object
.
curl --request POST \
--url http://localhost:3000/connect/v1/supply-chains/farmers/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"value": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"creator": "<string>",
"updater": "<string>",
"form": "<string>",
"product": "<string>"
},
"phone": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}'
{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"value": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>",
"form": "<string>",
"product": "<string>"
},
"phone": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}