Skip to main content
Version: 24.03

Client asking for MP information​

Client asking for MP information

Request Body required

Optional description in Markdown

  • request object

    Data model for a request

  • offset object required

    Send/start time of the first message/notification

    • "0" ==> immediate response
  • timeUnit string required

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number required

    The amount of timeUnits considered

  • customerId string required

    Internal customerId

  • precisionOfForecast object

    Accuracy of the time specification of the completion date.

    • default: implicitly defined by production
    • only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy.
  • timeUnit string required

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number required

    The amount of timeUnits considered

  • productionForecastForAll boolean required

    Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order

  • orderId string required

    The Id identifying subject of the request

  • deviationOfSchedule object

    Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber

    mandatory for CommunicationMode = "notification"

  • timeUnit string required

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number required

    The amount of timeUnits considered

  • notificationInterval object

    Interval time that either specifies the cyclic send time or limits the notification time mandatory for CommunicationMode = "cyclic"

  • timeUnit string required

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number required

    The amount of timeUnits considered

  • communicationMode string required

    Possible values: [synchronous, cyclic, notification]

    Specification of the communication mode

  • versionDataModel string required

    Specifies the used version of the data model

  • header object required

    Contains information common to all messages

  • messageId string required

    Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.

  • context string required

    Information about the context the message should be considered in. Default: For Use Cases which need to validate against the Semantic Hub automatically. Fallback: For Use Cases which do not use automatic validation. In both cases: Versioning only refers to major versions. String pattern of the value follows: ---

  • sentDateTime string required

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard

  • senderBpn string required

    The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard

  • receiverBpn string required

    The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.

  • expectedResponseBy string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard

  • relatedMessageId string

    Unique ID identifying a message somehow related to the current one

  • version string required

    The version of the standard defining the semantics and the structure of the message's header. The version number should follow the Semantic Versioning 2.0.0 specification.

Responses

OK. The request has succeeded

Loading...