S360 Services
Home
Home
Azure DevOps Repository
  1. Applications
  • Component Diagram
  • S360 Providers
    • BackOffice Workspace
      • Application
        • Submit Application
        • Application Status
      • Service Provisioning
        • Service Provisioning Request
        • Service Provisioning Status
      • Payment
        • Pricing Request
        • Payment Confirmation
      • References
    • IID Authorization
      • Get Context
      • Create Child Session
      • Get Child Session
      • Refresh Child Session
      • Validate Child Session
      • Logout Child Session
      • Add messages
    • MDM
      • License
        • QueryLicenses
  • S360
    • BackOffice
      • Application
        • Application Decision
      • Service Provisioning
        • Service Provisioning
    • IID Portal
      • Read This First
      • Application Status
      • Services
        • Get My Services
        • Get My Service Details
        • Start My Application
      • Applications
        • Get My Applications
          POST
        • Get My Application Details
          GET
        • Complete My Application
          LINK
        • View My Application
          LINK
      • Inventory
        • Get My Inventories
        • Get My Inventory Details
      • Payment
        • CompletePayment
        • GetPaymentDetails
        • ConfirmPayment
        • GetDuePaymentDetails
        • GetPastPaymentDetails
        • GetMyDuePayments
        • GetMyPastPayments
        • GetMyPaymentDetails
        • GetMyPayments
      • Document
        • Retrieve Document
    • Application Workspace
      • Read This First
      • SSO
        • Authenticate
        • Refresh Session
      • Application
        • GetContext App
        • GetContext User
        • Submit My Application
        • Notify Application Status
      • Document
        • Upload Document
        • Retrieve Document
      • Proxy
        • Get Reference Data from Entity
      • DesignTime
        • Upload Application Schema
    • Rules Engines
      • Payment
  1. Applications

Get My Application Details

Developing
GET
https://s360-app-apiqa.detsandbox.com/applications/v1/application/{applicationId}
Last modified:2024-10-02 04:02:38
OperationId:GetMyApplication

Overview#

When Investor browse the services, the list of applications of certain services might be available. IID Portal shall pass the ApplicationId and system will return the details of the application instance details.

Sequence Diagram#

Pre-condition:
Investor in S360 Dashboard and application instance is available
mermaid-s360-GetMyApplicationDetails
Remarks:
This operation differs with ViewMyApplication which involve redirection to the ApplicationWorkspace.
This operation is only accessible within the within the DET Application Cluster.
APIM shall expose the same IID Middleware endpoints (wildcard). The IID Middleware and S360 Proxy are expected to forward the request and its corresponding reply from and to the APIM.

API Specification#

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Path Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://s360-app-apiqa.detsandbox.com/applications/v1/application/' \
--header 'X-Request-Id: {{$string.uuid}}' \
--header 'x-IID-Sid: {{$string.uuid}}' \
--header 'X-IID-TraceId: {{$string.uuid}}' \
--header 'x-IID-Usr-CorrelationId: {{$string.numeric}}' \
--header 'X-API-Key;'

Responses

🟢200Success
application/json
Body

Examples
{
    "status": 200,
    "externalId": "bd77c6ec-a156-4cef-8d7b-4bffb800af80",
    "esbUUID": "cee8c26f-b6ec-485d-81be-f48283d03f4f",
    "desc": {
        "code": "ESB-360-S0000",
        "en": "Success",
        "ar": "نجاح"
    },
    "application": {
        "appIdentifier": {
            "applicationId": "f535e97e-8280-4e03-95d5-fc28a2313c2e",
            "serviceId": "Service-1",
            "entityId": "RTA",
            "serviceName": "Service-1",
            "serviceVersion": "v1"
        },
        "appState": {
            "en": "In Progress",
            "ar": "في تَقَدم"
        },
        "appAudit": {
            "steps": [
                {
                    "seqNo": 1,
                    "type": "Completed",
                    "rule": {
                        "en": "Consent To Apply",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Obtained",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "2013-09-13T16:02:36.905Z",
                    "lastUpdatedOn": "2001-01-23T20:28:06.061Z",
                    "initialUpdatedBy": "9",
                    "lastUpdatedBy": "5"
                },
                {
                    "seqNo": 2,
                    "type": "Completed",
                    "rule": {
                        "en": "Pay To Apply",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Paid",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "1976-03-04T08:49:13.715Z",
                    "lastUpdatedOn": "2002-07-08T20:19:05.848Z",
                    "initialUpdatedBy": "8",
                    "lastUpdatedBy": "5"
                },
                {
                    "seqNo": 3,
                    "type": "Info",
                    "rule": {
                        "en": "Application",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Pending",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "1951-08-23T19:36:37.463Z",
                    "lastUpdatedOn": "1960-08-09T03:10:08.415Z",
                    "initialUpdatedBy": "2",
                    "lastUpdatedBy": "4"
                },
                {
                    "seqNo": 4,
                    "type": "Info",
                    "rule": {
                        "en": "Pay To Submit",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Pending",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "1951-08-23T19:36:37.463Z",
                    "lastUpdatedOn": "1960-08-09T03:10:08.415Z",
                    "initialUpdatedBy": "2",
                    "lastUpdatedBy": "4"
                },
                {
                    "seqNo": 5,
                    "type": "Info",
                    "rule": {
                        "en": "Decision",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Pending",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "1951-08-23T19:36:37.463Z",
                    "lastUpdatedOn": "1960-08-09T03:10:08.415Z",
                    "initialUpdatedBy": "2",
                    "lastUpdatedBy": "4"
                },
                {
                    "seqNo": 6,
                    "type": "Info",
                    "rule": {
                        "en": "Provisioning",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Pending",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "1951-08-23T19:36:37.463Z",
                    "lastUpdatedOn": "1960-08-09T03:10:08.415Z",
                    "initialUpdatedBy": "2",
                    "lastUpdatedBy": "4"
                }
            ],
            "submissionCount": 0,
            "moreInfoRequired": false,
            "requestedBy": {
                "legalEntityId": "4",
                "userId": "Rhianna_Pacocha"
            },
            "requestedFor": "Loyce_Hamill31",
            "readOnly": false
        },
        "appWorkspace": {
            "mainLandingPage": "https://unhealthy-contractor.net/",
            "applicationLandingPage": "https://political-nougat.name/",
            "successfulEntryPage": "https://enraged-tomatillo.com/",
            "exceptionEntryPage": "https://best-scorpion.biz"
        },
        "availableActions": [
            {
                "code": "7",
                "en": "Complete My Application",
                "ar": "أكمل طلبي"
            }
        ],
        "dulNumber": "DUL0001",
        "appQuotes": [
            {
                "quotationId": "f535e97e-8280-4e03-95d5-fc28a2313c2e:1",
                "payType": "PayToApply",
                "serviceId": "Service-1",
                "applicationId": "f535e97e-8280-4e03-95d5-fc28a2313c2e",
                "itemized": [
                    {
                        "itemId": "9034",
                        "itemName": "Sausages",
                        "itemType": "Plastic",
                        "beneficiaryId": "RTA",
                        "unitPrice": 701.39,
                        "quantity": 1,
                        "total": 214.29,
                        "currency": "AED"
                    }
                ],
                "total": 665.05,
                "currency": "AED",
                "status": "Paid",
                "quotedOn": "2024-10-01T00:27:14.113Z",
                "expiredOn": "2024-10-01T07:58:13.126Z"
            }
        ]
    }
}
🟠400Bad Request
🔴500Internal Server Error
Modified at 2024-10-02 04:02:38
Previous
Get My Applications
Next
Complete My Application
Built with