Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Users need to be able to apply different kinds of overrides in multiple steps. Specifically, override of patron blocks will be added (

Jira Legacy
serverSystem JiraFOLIO Issue Tracker
serverId01505d016ccf3fe4-b8533301-3c2e368a-90f1983e-ee9b165564fc20c466b11a49
keyUXPROD-1130
) as well as override of item blocks (
Jira Legacy
serverSystem JiraFOLIO Issue Tracker
serverId01505d016ccf3fe4-b8533301-3c2e368a-90f1983e-ee9b165564fc20c466b11a49
keyUXPROD-2127
). The desired check-out flow should look like this:

...

  • key: "overridableBlocks", value: comma-separated string
    A list of blocks that need to be overridden in order to complete this action. If this is the only error returned by the server and there are no other parameters, the client will know that it is possible to complete this action by overriding existing blocks. Existence of other kinds of errors tells the client that it doesn't make sense to override these blocks.
  • key: "missingOverridePermissions", value: comma-separated string (optional)
    If there are overridableBlocks, server may also include a list of missing override permissions. The user won't be able to complete this action, but he or she may want to request permission escalation (
    Jira Legacy
    serverSystem JiraFOLIO Issue Tracker
    serverId01505d016ccf3fe4-b8533301-3c2e368a-90f1983e-ee9b165564fc20c466b11a49
    keyUXPROD-2645
    ) based on this information.

...

Code Block
"overrideBlocks": {
    "description": "Blocks that need to be overridden",
  "type": "object",
  "properties": {
    "itemNotLoanableBlock" : {
      "description": "Parameters for overriding of the 'item not loanable' block",
        "type": "arrayobject",
  "items":{
    
      "properties": {
        "dueDate": {
          "description": "Due date for a new loan",
          "type": "string",
          "format": ",
    "enum": [
      "patron-block",
      "item-limit-block",
      "item-not-loanable-block"
    ]
  date-time"
        }
      },
      "required": [
        "dueDate"
      ]
    },
    "patronBlock": {
      "description": "Parameters for overriding of the patron block",
      "type": "object",
      "properties": {
        ...
      }
    },
    "itemLimitBlock": {
      "description": "Parameters for overriding of the 'item limit' block",
      "type": "object",
      "properties": {
        ...
      }
    }
  }
}

List of the appropriate blocks and their parameters may be dependent on the endpoint.

...