7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Provisions the issued licence/permit (with the signed document) back to DET.

Request builder

Reference details

Path Parameters

providerCode*string

serviceId*string

applicationId*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/v1/service/provisioning/RTA/S-RTA-0001/1/A-DUL0001-S-RTA-0001-17297409693/status" \  -H "Content-Type: application/json" \  -d '{    "code": "Provisioned",    "desc": {      "code": "S-ESB-000001",      "en": "Success",      "ar": "نجاح"    },    "referenceId": "4b02872b-0012-4b0e-b48b-83b9f179c1a7",    "documents": [      {        "docType": "Permit",        "fileName": "permit.pdf",        "fileType": "pdf",        "content": "QFRfQ2pJOnZdQw=="      }    ],    "data": [      {        "label": {          "en": "MOHRE Establishment Card Number",          "ar": "رقم بطاقة منشأة"        },        "value": "1234567"      }    ]  }'

{  "status": 200,  "desc": {    "en": "Success",    "ar": "نجاح",    "code": "200"  },  "correlationId": "75be3872-da72-4325-9957-36ddc708588a"}

{  "status": 400,  "desc": {    "en": "Invalid document content",    "ar": "محتوى مستند غير صالح",    "code": "400"  }}

{  "status": 401,  "desc": {    "en": "Unauthorized",    "ar": "غير مصرح",    "code": "401"  }}

{  "status": 404,  "desc": {    "en": "Failure: No License Request found",    "ar": "فشل",    "code": "404"  },  "correlationId": null}

{  "status": 500,  "desc": {    "en": "Internal server error",    "ar": "خطأ في الخادم",    "code": "500"  }}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`