imsxStatusInfoDType21

This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider. For the OneRoster Rostering service this object will only be returned to provide information about a failed request i.e. it will NOT be in the payload for a successful request.

  • imsx_codeMajor
    Type: stringenum
    required

    The code major value (from the corresponding enumerated vocabulary).

    values
    • success
    • processing
    • failure
    • unsupported
  • imsx_severity
    Type: stringenum
    required

    The severity value (from the corresponding enumerated vocabulary).

    values
    • status
    • warning
    • error
  • imsx_CodeMinor
    Type: object · imsxCodeMinorDType2

    This is the container for the set of code minor status codes reported in the responses from the Service Provider.

    • imsx_codeMinorField
      Type: array object[] · imsxCodeMinorFieldDType2[] 1…
      required

      Each reported code minor status code.

      This is the container for a single code minor status code.

  • imsx_description
    Type: string

    A human readable description supplied by the entity creating the status code information.