Overview

Investor can query all the inventory instances available for their TradeLicense.

This operation might be invoked in following conditions:
1. Investor in the Requests section. IID Portal shall query the inventory instances available for specific TradeLicense.
2. Investor in the Inventory Section. IID Portal shall query the inventory instances available for a TradeLicense and specific service.

System will return the list of inventories 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 Inventory section

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.

TODO
I18n for displayable fields

API Specification

Request

Authorization

Add parameter in header

X-API-Key

Example:

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

Header Params

Body Params application/json

Example

{
    "requestControl": {
        "returnApp": true,
        "returnAppAudit": true
    },
    "query": {
        "dulNumber": [
            "97491",
            "92567"
        ],
        "serviceId": "Electric"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "6373a0e1-3ce4-4298-b2b5-cb730e44df7a",
    "esbUUID": "50ac72b1-48fa-419d-a435-86f527a39ade",
    "desc": {
        "code": "233428530359390",
        "en": "perspiciatis voluptate occaecati",
        "ar": "eu dolor"
    },
    "inventories": [
        {
            "inventoryId": "ee5aac19-5a6e-4ff8-9175-63c399bd12c7",
            "dulNumber": "36827",
            "serviceId": "Manat",
            "serviceVersion": "6.1.5",
            "entityId": "e-business",
            "state": "Provisioned",
            "provisionedOn": "2021-12-10T17:15:36.226Z",
            "expiredOn": "2024-09-13T16:21:28.318Z",
            "applications": [
                {
                    "lifecycle": "Normal",
                    "applicationId": "e3b3b278-de3b-414a-bb43-ee2e12e1f1c3",
                    "appAudit": {
                        "readOnly": true,
                        "requestedOn": "2024-09-12T23:40:04.637Z",
                        "requestedFor": "Leola_Oberbrunner32",
                        "requestedBy": {
                            "legalEntityId": "dolor sint",
                            "userId": "est"
                        },
                        "lastUpdatedOn": "2024-09-12T07:54:08.835Z",
                        "lastUpdatedBy": "Leta_Spencer",
                        "initialSubmissionOn": "2024-09-12T21:04:24.429Z",
                        "initialSubmissionBy": "Amiya62",
                        "lastSubmissionOn": "2024-09-12T03:34:28.741Z",
                        "lastSubmittedBy": "Ottis.Reilly31",
                        "initialDecisionOn": "2024-09-12T04:32:17.604Z",
                        "lastDecisionOn": "2024-09-12T14:55:09.699Z",
                        "fulfilledOn": "2024-09-13T00:24:46.936Z",
                        "provisionedOn": "2024-09-12T12:43:17.917Z",
                        "moreInfoRequired": false,
                        "submissionCount": 8,
                        "remarks": [
                            {
                                "en": "withdrawal",
                                "ar": "Royce payment",
                                "updatedOn": "2024-09-12T12:53:42.265Z",
                                "updatedBy": "ullamco qui nostrud dolor laboris"
                            },
                            {
                                "en": "Concrete",
                                "ar": "Volvo Tesla Iodine",
                                "updatedOn": "2024-09-13T02:17:43.022Z",
                                "updatedBy": "amet commodo irure aliqua sit"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Get My Inventories

Overview#