Application Decision

Integrating

PUT

/v1/application/{entityId}/{serviceId}/{serviceVersion}/{applicationId}/decision

Last modified:2024-10-04 07:35:50

OperationId:NotifyDecision

Overview

This API is provided for Service Provider / Government Entity to update the decision of application submitted by the investor

Specification

Decision: In Progress

PUT /v1/application/RTA/Service-1/1.0/33fe7091-394e-4158-a9d9-bdee296b50a1/decision
{
    "code": "0",
    "status": {
        "en": "In Progress",
        "ar": "في تَقَدم"
    },
    "remarks": [
        {
            "code": "RTA-CODE-0001",
            "en": "Application is waiting for decision",
            "ar": "التطبيق ينتظر القرار"
        }
    ]
}

Decision: Approved

PUT /v1/application/RTA/Service-1/1.0/33fe7091-394e-4158-a9d9-bdee296b50a1/decision
{
    "code": "1",
    "status": {
        "en": "Approved",
        "ar": "موافقة"
    },
    "remarks": [
        {
            "code": "RTA-CODE-0000",
            "en": "Application is approved",
            "ar": "تمت الموافقة على الطلب"
        }
    ]
}

Decision: Rejected

Decision: More Info Required

Request

Authorization

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "code": "1",
    "status": {
        "en": "Approved",
        "ar": "موافقة"
    },
    "remarks": [
        {
            "code": "RTA-CODE-0000",
            "en": "Success",
            "ar": "نجاح"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT '/v1/application/{% faker database.mongodbObjectId %}/{% faker database.mongodbObjectId %}/v1.0/{% faker datatype.uuid %}/decision' \
--header 'X-Request-Id: {% faker datatype.uuid %}' \
--header 'Content-Type: application/json' \
--header 'X-API-Key;' \
--data-raw '{
    "code": "1",
    "status": {
        "en": "Approved",
        "ar": "موافقة"
    },
    "remarks": [
        {
            "code": "RTA-CODE-0000",
            "en": "Success",
            "ar": "نجاح"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "33fe7091-394e-4158-a9d9-bdee296b50a1",
    "esbUUID": "710fbf9c-557f-48f9-b9d4-15a13b911483",
    "desc": {
        "code": "ESB-S360-0000",
        "en": "Success",
        "ar": "نجاح"
    }
}

Modified at 2024-10-04 07:35:50

QueryLicenses

Service Provisioning