MEF Appointment API is one of 54 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Appointment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 2 paths,
and defines 36 schemas.
It is described by OpenAPI 3.2.0, at version 3.0.1.
Requests are made against 2 base URLs: https://{serverBase}/mefApi/cantata/appointment/v3/, https://{serverBase}/mefApi/sonata/appointment/v3/.
The identity and technical contract details declared by the specification.
RelatedPlaceRefOrQuery
object
Allows pointing to a place by referring to a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional informatio…
3 properties
2 required
Appointment_Update
object
In the context of MEF 113 document, denotes an arrangement between the Buyer and Seller for a Seller Technician to meet with the Buyer at a specified time and…
5 properties
Note
object
Extra information about a given entity. Only useful in processes involving human interaction. Not applicable to an automated process.
5 properties
5 required
ContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
6 properties
3 required
PlaceRefOrQuery
object
A place described by reference to a Geographic Address, Geographic Site or by Geographic Address Representations.
GeographicAddressRef
object
A reference to a Geographic Address resource available through Address Validation API.
3 properties
2 required
AppointmentStatusType
string
Valid values for the lifecycle status of the appointment. | status | MEF 113 name | Description | | ----------------------- | ---------------------- | --------…
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
DataSizeUnit
string
The unit of measure in the data size.
LabelRepresentation
object
A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
3 properties
2 required
FieldedAddressRepresentation
object
A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" i…
20 properties
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
GeographicSiteRef
object
A reference to a Geographic Site resource available through Service Site API
3 properties
2 required
AttachmentValue
object
Complements the description of an element (for instance a product) through video, pictures...
8 properties
5 required
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
GeographicPointRepresentation
object
A GeographicPointRepresentation defines a geographic point through coordinates.
4 properties
3 required
MEFByteSize
object
A size represented by value and Byte units
2 properties
2 required
MEFBuyerSellerType
string
An enumeration with buyer and seller values.
WorkOrderRef
object
A reference to an WorkOrder resource.
2 properties
1 required
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
SubUnit
object
Allows for sub unit identification
2 properties
2 required
Appointment
object
In the context of MEF 113 document, denotes an arrangement between the Buyer and Seller for a Seller Technician to meet with the Buyer at a specified time and…
9 properties
6 required
RelatedContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
7 properties
4 required
GeographicAddress_Query
object
A list of representations being a subset of Geographic Address entity. This is to be used when providing a list of representations to validate or search for a…
5 properties
1 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property the Seller has expected is not present in the payload - invalidValue: The property has an inc…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Appointment_Find
object
In the context of MEF 113 document, denotes an arrangement between the Buyer and Seller for a Seller Technician to meet with the Buyer at a specified time and…
6 properties
5 required
Error403
Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
Error409
Conflict (https://datatracker.ietf.org/doc/html/rfc7231section-6.5.8)
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
2 required
Appointment_Create
object
In the context of MEF 113 document, denotes an arrangement between the Buyer and Seller for a Seller Technician to meet with the Buyer at a specified time and…
5 properties
3 required
FormattedAddressRepresentation
object
A freeform text representation agreed to by the Buyer and Seller.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
