Unfinalize Authorization
Authorizations in approved and denied status can be brought back in the "Change" status by the unfinalize operation. The steps of unfinalizing are described in Unfinalize Authorization
-
When an authorization is either in the status "Approved" or "Denied", an unfinalize link is added to the authorization resource:
The table below gives an overview:
Status of the authorization | Link Resource Available |
---|---|
Entry |
No |
In Process |
No |
Pended |
No |
Changed |
No |
Approved |
Yes |
Denied |
Yes |
{
"links": [
{
"href": "http://[hostName]:[portNumber]/[api-context-root]/generic/authorizations/{id>},
"rel": "self"
},
{
"href": "http://[hostName]:[portNumber]/[api-context-root]/authorizations/{id}/unfinalize",
"rel": "authorization:unfinalize",
"httpMethod": "POST"
}
]
}
-
Clicking on this link system asks to attach an Unfinalize Reason. Clients must send one authorization unfinalize reasons in the POST payload:
[source,text
{ "authorizationUnfinalizeReason": { "unfinalizeReason": { "id": "<id of unfinalize reason>" } } }
-
In the example, unfinalize reasons is passed. Without an unfinalize reason, HTTP Status 400 (Bad Request) is returned, with additional error message "AUT-IP-AUTI-015" - "An unfinalize reason is required when updating an authorization with status APPROVED or DENIED".
-
The unfinalize reasons in the payload will replace possibly existing unfinalize reasons for the authorization.
-
HTTP Status 201 is returned together with a representation of the authorization resource (which is now in status Change").
-
Response Header with re-direction link to authorization is provided
Operation
For Authorizations in Approved or Denied Status
-
For the current version of the Authorization, sets the indicator Last Version of the Authorization to false
-
Creates a new version of the Authorization (copy of the current version including its dynamic fields and dynamic records) and copies the following underlying children (including their dynamic fields and dynamic records):
-
Authorization Lines
-
Authorization Basket
-
Authorization Service Type
-
Authorization Diagnosis
-
Authorization Messages
-
-
Creates the Authorization status history for status Edit for the newly created Authorization version
-
Sets the indicator Last Version of the Authorization to true for the newly created Authorization
Authorization
The operation in this section is protected by access restriction "authorization.unfinalize IP". A grant must be given with create, read and update flag set. A Read grant must also be given to access restriction "authorizations API".
Response Message
Failure
Response | Description |
---|---|
AUT-IP-AUTO-001 |
Authorization id {id} is unknown |
AUT-IP-AUTI-012 |
Unfinalize reason code {0} is unknown |
AUT-IP-AUTI-015 |
An unfinalize reason is required when updating an authorization with status 'APPROVED' or 'DENIED' |
AUT-IP-AUTI-026 |
Authorizations in status {status} cannot be Unfinalized |
See Response Messages for more details.