Deny Lock Request

A lock request can be cancelled by the secondary desk officer if it does not meet the required criteria.

πŸ“˜

Deny Lock Action Details

Deny Lock accepts the lock id.

  • When no lock id is passed by the consumer, EPC treats that as request to deny lock in requested state only, i.e. EPC only tries to find an active lock in requested state and denies that. This is to prevent the integration from inadvertently denying a confirmed lock.
  • If the integration explicitly passes the lockId, then EPC does not check if the lock is in requested or confirmed state, and passes through for Encompass APIs. It is recommended that you exercise additional caution when using this functionality.

The JSON-schema definition below details supported attributes for the Deny Lock operation:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "description": "JSON representation of a deny lock request transaction result.",
  "validationMessage": {
    "uuidPattern": "UUID. It must be a valid UUID format"
  },
  "properties": {
    "lockId": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "validationMessage": {
        "$ref": "#/validationMessage/uuidPattern"
      }
    },
    "comments": {
      "type": "string"
    }
  },
  "required": [
    "comments"
  ],
  "additionalProperties": false
}

Below is a sample payload for the Deny Lock request operation:

{
  "status": "Completed",
  "result": {
    "format": "application/vnd.productpricing-denylock-1.0.0.json",
    "action": "DENY",
    "details": {
      "lockId": "84dc19a5-24be-485a-831e-2420b92608e2",
      "comments": ""
    }
  }
}

If you need any help implementing the custom result operations detailed above in your integration, you can post your questions and/or look for answers on our Discussion board. Our discussion board is actively tracked by a community of experts who are available to help you out when you get stuck. You can also send your questions and issues to the EPC core development team at [email protected]. Happy hacking!