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 Applications

Developing
POST
https://s360-app-apiqa.detsandbox.com/applications/v1
Last modified:2024-10-02 04:02:34
OperationId:GetMyApplications

Overview#

Investor can query all the application instances available for their TradeLicense.
This operation might be invoked in following conditions:
1. Investor in the Requests section. IID Portal shall query the application instances available for specific TradeLicense.
2. Investor in the Application Log. IID Portal shall query the application instances available for a TradeLicense and specific service.
System will return the list of applications for above criterias.

Sequence Diagram#

Pre-condition:
1.
Investor authenticated in IID Portal and select a TradeLicense AND
2.
Investor go to Request section OR
3.
Investor go to Application Log section for specific section
mermaid-s360-GetMyApplications
Remarks:
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: ********************
Header Params

Body Params application/json

Example
{
    "requestControl": {
        "returnAppStatus": true,
        "returnAppAudit": true,
        "returnAppWorkspace": true
    },
    "query": {
        "dulNumber": [
            "string"
        ],
        "legalEntityId": "string",
        "situation": [
            "string"
        ]
    }
}

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 POST 'https://s360-app-apiqa.detsandbox.com/applications/v1' \
--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 'Content-Type: application/json' \
--header 'X-API-Key;' \
--data-raw '{
    "requestControl": {
        "returnAppStatus": true,
        "returnAppAudit": true,
        "returnAppWorkspace": true
    },
    "query": {
        "dulNumber": [
            "string"
        ],
        "legalEntityId": "string",
        "situation": [
            "string"
        ]
    }
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "externalId": "0d5087a0-a259-43d7-9b5a-da476bd37459",
    "esbUUID": "5c6f2ea1-6d3b-4ab1-bab2-928b13e7324d",
    "desc": {
        "code": "ESB-360-S0000",
        "en": "Success",
        "ar": "نجاح"
    },
    "applications": [
        {
            "appIdentifier": {
                "applicationId": "19c73388-198b-49d3-90c1-1d48e6d6710c",
                "serviceId": "Service-1",
                "entityId": "RTA",
                "serviceName": "Tasty Wooden Towels",
                "serviceVersion": "v1"
            },
            "appState": {
                "en": "Submitted",
                "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": "Completed",
                        "rule": {
                            "en": "Application",
                            "ar": "التسمية العربية"
                        },
                        "state": {
                            "en": "Completed",
                            "ar": "التسمية العربية"
                        },
                        "initialUpdatedOn": "1951-08-23T19:36:37.463Z",
                        "lastUpdatedOn": "1960-08-09T03:10:08.415Z",
                        "initialUpdatedBy": "2",
                        "lastUpdatedBy": "4"
                    },
                    {
                        "seqNo": 4,
                        "type": "Completed",
                        "rule": {
                            "en": "Pay To Submit",
                            "ar": "التسمية العربية"
                        },
                        "state": {
                            "en": "Paid",
                            "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": "In Progress",
                            "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": 1,
                "moreInfoRequired": false,
                "requestedBy": {
                    "legalEntityId": "4",
                    "userId": "Rhianna_Pacocha"
                },
                "requestedFor": "Loyce_Hamill31",
                "readOnly": true
            },
            "appWorkspace": {
                "mainLandingPage": "http://poor-head.name",
                "applicationLandingPage": "https://alarmed-hops.org",
                "successfulEntryPage": "https://this-hunt.name",
                "exceptionEntryPage": "http://early-nitrogen.info"
            },
            "availableActions": [
                {
                    "code": "7",
                    "en": "View My Application",
                    "ar": "التسمية العربية"
                }
            ],
            "dulNumber": "DUL0001"
        }
    ]
}
🟠400Bad Request
🔴500Internal Server Error
Modified at 2024-10-02 04:02:34
Previous
Start My Application
Next
Get My Application Details
Built with