Here you can find the definitions of various fields as per the domain and their example values and allowed set of values if applicable.
| Schema fields | Description | Example | Enums |
|---|---|---|---|
| context.domain | Name of the ONEST Domain | onest:work-opportunities | onest:learning-experiences, onest:financial-support, onest:work-opportunities, onest:expert-connect |
| context.location.city.name | Name of the City | Bangalore | |
| context.location.city.code | City Code | std:080 | List of city codes |
| context.location.country.name | Name of the Country | India | |
| context.location.country.code | Country Code, It is a ISO code | IND | |
| context.action | Defines the API call. Any actions other than the ennumerated actions are not supported by Beckn Protocol. | search | search, select, init, confirm, update, status, track, cancel, rating, support, on_search, on_select, on_init, on_confirm, on_update, on_status, on_track, on_cancel, on_rating, on_support |
| context.timestamp | Time of request generation | 2023-02-06T09:55:41.161Z | |
| context.ttl | The duration after timestamp for which this message holds valid. It should be in ISO Duration Format. | PT10M | |
| context.version | Version of Beckn core API specification being used | 1.1.0 | |
| context.bap_id | Subscriber id of the BAP | sample.bap.io | |
| context.bap_uri | Subscriber URI of the BAP | https://sample.bap.io | |
| context.bpp_id | Subscriber id of the BPP | sample.bpp.io | |
| context.bpp_uri | Subscriber URI of the BAP | https://sample.bpp.io | |
| context.transaction_id | This is a unique value which persists across all API calls from search through confirm. Should be a UUID. | a9aaecca-10b7-4d19-b640-b047a7c62196 | |
| context.message_id | This is a unique value which persists during a request / callback cycle. Example search (request) and on_search (callback) will have the same message id. Should be a UUID. | 0d30bfbf-87b8-43d2-8f95-36ebb9a24fd6 | |
| order.id | Human-readable ID of the order. This is generated by the BPP | OD-123 | |
| provider.id | Id of the job provider | JOB_PVDR_123 | |
| provider.descriptor.name | Name of the job provider | ||
| provider.descriptor.short_desc | Short description about the job provider | ||
| provider.descriptor.images[].url | URL to the image/logo of the job provider | ||
| provider.locations[].id | ID of the location being defined. This is used to define any location constraint that a scholarship might have. For example scholarship for only students from a specific state | ||
| provider.locations[].state.name | Name of the state | Karnataka | |
| provider.locations[].state.code | ISO code of the state | KA | ISO state codes |
| provider.locations[].city.name | Name of the City | Bangalore | |
| provider.locations[].city.code | City Code | std:080 | List of city codes |
| items[].id | ID of the job | JOB_63587501 | |
| items[].descriptor.name | Name of the job | Assembly line worker | |
| items[].descriptor.long_desc | Description about the job | ||
| items[].fulfillment_ids[] | Modes through which this item can be fulfilled | ||
| items[].location_ids[] | Job Provider Locations this item is available in | ||
| items[].price.currency | currency | INR | |
| items[].price.value | scholarship amount | 10000 | |
| items[].price.minimum_value | Can be used in case the scholarship amount is a range | 10000 | |
| items[].price.maximum_value | Can be used in case the scholarship amount is a range | 20000 | |
| items[].time.range.start | Start date of the job application | ||
| items[].time.range.end | End date of the job application | ||
| items[].tags[].display | Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search. | ||
| items[].tags[].descriptor.code | Human-readable code of the tag group | ||
| items[].tags[].descriptor.name | Name of the tag group | ||
| items[].tags[].list[].descriptor.code | Human-readable code of the tag | ||
| items[].tags[].list[].descriptor.name | Name of the tag | ||
| items[].tags[].list[].value | Value of the tag | ||
| items[].tags[].list[].display | Indicates to display or not | ||
| fulfillments[].state.descriptor.code | Human readble code of the fulfillment status | APPLICATION-STARTED | "APPLICATION-STARTED", "APPLICATION-IN-PROGRESS", "APPLICATION-FILLED", "APPLICATION-SUBMITTED", "APPLICATION-REJECTED", "ASSESSMENT-IN-PROGRESS", "OFFER-EXTENDED", "OFFER-ACCEPTED", "OFFER-REJECTED" |
| fulfillments[].state.descriptor.name | Name of the fulfillment status | Application Started | "Application Started", "Application in Progress", "Application Filled", "Application Submitted", "Application Rejected", "Assessment in Progress", "Offer Extended", "Offer Accepted", "Offer Rejected" |
| fulfillments[].type | How the job will be fullfilled | REMOTE | "REMOTE", "HYBRID", "ONSITE" |
| fulfillments[].state.updated_at | Status updated time (ISO Format) | 2023-02-06T09:55:41.161Z | |
| fulfillments[].customer.person.age | Age of the job applicant | ||
| fulfillments[].customer.person.gender | Gender of the job applicant | Male | Male, Female, Transgender, Other |
| fulfillments[].customer.person.skills[].code | code of the skill | ||
| fulfillments[].customer.person.skills[].name | name of the skill | ||
| fulfillments[].customer.person.languages[].code | code of the language | ||
| fulfillments[].customer.person.languages[].name | name of the language | ||
| fulfillments[].customer.contact.phone | Phone number of the job applicant | ||
| fulfillments[].customer.contact.email | Email address of the job applicant | ||
| xinput.required | Whether submission of the form is requried for the order | TRUE | |
| xinput.head.descriptor.name | Heading for the form | ||
| xinput.head.index.min | Minimum index to be used for forms. Recommended value is 0. | 0 | |
| xinput.head.index.cur | Index of the current form being sent by the BPP. | 2 | |
| xinput.head.index.max | Maximum index of forms that will be sent by the BPP. | 3 | |
| xinput.head.headings[] | Headings of the forms. If there are 3 different forms that will be sent in 3 different on_init calls the haeadings for the same will be present here | ["Personal Details","Educational Details","Review & Submit"] | |
| xinput.form.mime_type | Mime type of the form | text/html | "text/html", "application/xml" |
| xinput.form.url | URL of the form | https://bpp.com/form/txn12393 | |
| xinput.form.resubmit | Whether resubmission is allowed. False by default. | FALSE |