Show Source

• expiry: string (date-time)
  Expiry
• lockUser: string (uuid)
  Lock user GUID
• lockUsername: string
  Lock user name.

  Example: username

{
    "title":"LockDto v1.0",
    "type":"object",
    "properties":{
        "lockUser":{
            "type":"string",
            "description":"Lock user GUID",
            "format":"uuid"
        },
        "lockUsername":{
            "type":"string",
            "description":"Lock user name.",
            "example":"username"
        },
        "expiry":{
            "type":"string",
            "description":"Expiry",
            "format":"date-time"
        }
    },
    "description":"Study lock details."
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}