ofOpen Finance Guide
GlosarioSTETBlogContacto
Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)ISO 8601

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    detailed error description

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      Code
      header
      query
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

      • minValueinteger
      • maxValueinteger
    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

      • minValueinteger
      • maxValueinteger
    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with