Versions Compared

Version Old Version 4 New Version 5
Changes made by

Paul Garus

Paul Garus

Saved on

Key

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

...

Expand
titlePrequalification of the PQ

The final step is to request the PQ. If not all the requirements for prequalification are met, the response of the endpoint will indicate this within the error message. The PQ ID is required to execute the endpoint. The requested action is written into the request body:

Code Block
curl -X 'POST' \
  'https://training.pq-portal.energy/pqapi/data/v1/prequalifications/{id}/action' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <accessToken>' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": "Request"
}'

The PQ is successfully requested when HTTP code 204 is returned.

For example, if an incorrect action is carried out (prequalify instead of request), the error message 'forbidden' indicates the reason as you can see here:

Code Block
{
  "statusCode": 403,
  "domain": "Pq_Api",
  "category": "Permission",
  "errorCode": "InsufficientPermissions",
  "message": "Insufficient permissions.",
  "reasons": [
    {
      "domain": "Pq_Api",
      "category": "Permission",
      "errorCode": "PrincipalDoesNotHavePermission",
      "message": "The principal (User) 75b65d5e-7962-4eb5-9a35-cacdd345ba57{id} does not have the permission ActivatePrequalification.",
      "contextType": "Permission",
      "context": {
        "userId": "75b65d5e-7962-4eb5-9a35-cacdd345ba57...",
        "permissionTypes": [
          "ActivatePrequalification"
        ],
        "typeName": "PermissionContext"
      }
    }
  ]
}