Consent notification

v1.0.0

This API is called by HIP as acknowledgement to notification of consents, in cases of consent revocation and expiration, notified by CM earlier via Gateway API - /v0.5/consents/hip/notify.

Input

{
  "type": "object",
  "required": [
    "requestId",
    "resp",
    "timestamp"
  ],
  "properties": {
    "acknowledgement": {
      "type": "object",
      "required": [
        "consentId",
        "status"
      ],
      "properties": {
        "consentId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "OK",
            "UNKNOWN"
          ]
        }
      }
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "enum": [
            1000,
            10001
          ]
        },
        "message": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "a nonce, unique for each HTTP request"
    },
    "resp": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid",
          "description": "the requestId that was passed"
        }
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ"
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}