Overview
A service asks for a defined set of information. The recipient supplies the requested values, and the service reports which response it recorded or which values need attention.
This is a proposal. Its operations and representation are still under discussion.
Proposed operations
Target: A request identifier and the version of the requested fields.
- Submit response
- Supply values for the requested fields.
- Decline
- Decline to provide the information. Whether this is recorded by the service or kept local remains open.
Inputs and results
Inputs. Values for the requested fields. The definition must specify required fields, validation rules and any supported attachments.
Results. A recorded response, rejected values or a request that can no longer be answered. Supplying information does not approve a separate business operation.
Permissions. The client needs permission to disclose the requested information. The service checks that the caller may respond to the request.
Human participation. A form with the same questions and validation rules.
The behaviour is described here. A machine-readable representation has not yet been selected.
Confirm a company’s contact details
- A directory asks for the company’s support address and website.
- An authorised representative supplies the two requested fields.
- The directory validates the values and records the response.
If the request has expired, the service reports that the response was not recorded. Providing contact details alone does not prove company ownership.
Existing standards
- Schema.org AskAction
Related vocabulary for posing a question.
- Schema.org ReplyAction
Related vocabulary for a response.
- JSON Schema 2020-12
A candidate for describing and validating JSON inputs.
Versions and open questions
Initial proposal
MailSchema is assessing the response model and its relationship to existing vocabularies. No version has been assigned.
- Field representation, partial responses and replacement of an earlier response.
- Attachments, deadlines and disclosure permissions.
- Whether declining a request is a service operation.
Contribute to this definition →
Implementations
No implementation evidence has been published for this proposal.
Support declarations and test reports are supplied by their contributors. Listing them does not certify compatibility. Each targets a type version, execution profile and exact record.