BPP provides the list of entities that can be rated in its system to the BAP
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
Form object
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
create a form
ID of the form
Successful closure of a chat session
Unique reference ID to the fulfillment of an order
A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.
Whether the fulfillment can be rated or not
The rating value of the fulfullment service.
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The current state of fulfillment. The Provider Platform must set this value whenever the state of the order fulfillment changes and fire an unsolicited on_status call.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether the fulfillment allows tracking
The person that will ultimately receive the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The agent that is currently handling the fulfillment of the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
An organization. Usually a recognized business entity.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.This has properties like category, capacity, make, model, size,variant,color,energy_type,registration
The list of logical stops encountered during the fulfillment of an order.
Location of the stop
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The type of stop. Allowed values of this property can be defined by the network policy.
Timings applicable at the stop.
Describes duration as per ISO8601 format
comma separated values representing days of the week
Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.This has properties like frequency, holidays, times
Describes duration as per ISO8601 format
Instructions that need to be followed at the stop
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Contact details of the stop
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The details of the person present at the stop
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.
Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
Token used for authorization. This is typically generated at the Provider Platform. The Consumer Interface can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.
Timestamp in RFC3339 format from which token is valid
Timestamp in RFC3339 format until which token is valid
Status of the token
The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Update fulfillment state for an order
Unique reference ID to the fulfillment of an order
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Successful closure of a chat session
Unique reference ID to the fulfillment of an order
A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.
Whether the fulfillment can be rated or not
The rating value of the fulfullment service.
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The current state of fulfillment. The Provider Platform must set this value whenever the state of the order fulfillment changes and fire an unsolicited on_status call.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether the fulfillment allows tracking
The person that will ultimately receive the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The agent that is currently handling the fulfillment of the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
An organization. Usually a recognized business entity.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.This has properties like category, capacity, make, model, size,variant,color,energy_type,registration
The list of logical stops encountered during the fulfillment of an order.
Location of the stop
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The type of stop. Allowed values of this property can be defined by the network policy.
Timings applicable at the stop.
Describes duration as per ISO8601 format
comma separated values representing days of the week
Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.This has properties like frequency, holidays, times
Describes duration as per ISO8601 format
Instructions that need to be followed at the stop
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Contact details of the stop
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The details of the person present at the stop
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.
Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
Token used for authorization. This is typically generated at the Provider Platform. The Consumer Interface can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.
Timestamp in RFC3339 format from which token is valid
Timestamp in RFC3339 format until which token is valid
Status of the token
The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Cancel the fulfillment for an order
Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.
Successful closure of a chat session
Unique reference ID to the fulfillment of an order
A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.
Whether the fulfillment can be rated or not
The rating value of the fulfullment service.
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The current state of fulfillment. The Provider Platform must set this value whenever the state of the order fulfillment changes and fire an unsolicited on_status call.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
ID of entity which changed the state
Indicates whether the fulfillment allows tracking
The person that will ultimately receive the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The agent that is currently handling the fulfillment of the order
Describes a person as any individual
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
An organization. Usually a recognized business entity.
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The postal address of the organization
Describes a postal address.
The state where the organization's address is registered
Name of the state
State code as per country or international standards
The city where the the organization's address is registered
Name of the city
City code
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Describes the contact information of an entity
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
Describes a vehicle is a device that is designed or used to transport people or cargo over land, water, air, or through space.This has properties like category, capacity, make, model, size,variant,color,energy_type,registration
The list of logical stops encountered during the fulfillment of an order.
Location of the stop
Physical description of something.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.
The GPS co-ordinates of this location.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$The address of this location.
Describes a postal address.
The city this location is, or is located within
Name of the city
City code
The state this location is, or is located within
The state this location is, or is located within
Name of the state
State code as per country or international standards
The country this location is, or is located within
Name of the country
Country code as per ISO 3166-1 and ISO 3166-2 format
Describes a circular region of a specified radius centered at a specified GPS coordinate.
Describes a GPS coordinate
^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$Describes a scalar
Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+Describes a numerical value in decimal form
[+-]?([0-9]*[.])?[0-9]+The boundary polygon of this location
The three dimensional region describing this location
The rating of this location
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
The type of stop. Allowed values of this property can be defined by the network policy.
Timings applicable at the stop.
Describes duration as per ISO8601 format
comma separated values representing days of the week
Describes schedule as a repeating time period used to describe a regularly recurring event. At a minimum a schedule will specify frequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the timestamps(s) of when the event will take place. Schedules may also have holidays to exclude a specific day from the schedule.This has properties like frequency, holidays, times
Describes duration as per ISO8601 format
Instructions that need to be followed at the stop
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Contact details of the stop
A Jcard object as per draft-ietf-jcardcal-jcard-03 specification
The details of the person present at the stop
Describes the identity of the person
Profile url of the person
the name of the person
Describes an image
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
Age of the person
Describes duration as per ISO8601 format
Date of birth of the person
Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy
URL of the credential
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
Describes an authorization mechanism used to start or end the fulfillment of an order. For example, in the mobility sector, the driver may require a one-time password to initiate the ride. In the healthcare sector, a patient may need to provide a password to open a video conference link during a teleconsultation.
Type of authorization mechanism used. The allowed values for this field can be published as part of the network policy.
Token used for authorization. This is typically generated at the Provider Platform. The Consumer Interface can send this value to the user via any channel that it uses to authenticate the user like SMS, Email, Push notification, or in-app rendering.
Timestamp in RFC3339 format from which token is valid
Timestamp in RFC3339 format until which token is valid
Status of the token
The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.
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.
Description of the TagGroup, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.
Description of the Tag, can be used to store detailed information.
indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838
The URL of the file
The digital signature of the file signed by the sender
The signing algorithm used by the sender
URL to the image. This can be a data url or an remote url
The size of the image. The network policy can define the default dimensions of each type
Width of the image in pixels
Height of the image in pixels
The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.
This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.
BPP provides the list of entities that can be rated in its system to the BAP
Category of the entity being rated
Id of the object being rated
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Form object
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Describes a form
ID of the form
The URL from where the form can be fetched. The content fetched from the url must be processed as per the mime_type specified in this object. Once fetched, the rendering platform can choosed to render the form as-is as an embeddable element; or process it further to blend with the theme of the application. In case the interface is non-visual, the the render can process the form data and reproduce it as per the standard specified in the form.
The form submission data
This field indicates the nature and format of the form received by querying the url. MIME types are defined and standardized in IETF's RFC 6838.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.