Overview

For eligible service, Investor starts the application.

The request send to Service Management, Rules Engine evaluate the eligibility based on service catalog - Service Eligibility criteria. See in the Wiki.

If the Investor is eligible then rules engine will evaluate the acceptance rules.

If ConsentRequired=true, it initiates the Consent Request to the Consent Management and return status=Pending Consent. Investor may proceed to the Consent Request Section in Portal.

If PaymentRequired(PayToApply)=true, it initiates the Payment Request to the Payment Collection and return status=Pending Quote. Investor may proceed to the Payment Section in Portal.

If none of above true, it return status=In-Progress and investor might proceed to "Complete Application".

Details of Acceptance rules are defined in the Service Catalog. See in the Wiki.

Sequence Diagram

Precondition:
Investor select eligible services which returns from GetMyServices()

Remark:
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.

State Diagram

The complete state diagram for StartMyApplication is available in Wiki.

TODO:
Relevant available actions

API Specification

Request

Authorization

Add parameter in header

X-API-Key

Example:

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

Path Params

Header Params

Body Params application/json

Example

{
    "requestedFor": "in commodo",
    "dulNumber": "DUL0001",
    "requestedBy": {
        "legalEntityId": "anim do aliqua",
        "userId": "reprehenderit Ut eu amet"
    },
    "inventoryLifecycle": "Amendment",
    "inventoryId": "ba6369e7-296d-4fb5-b39a-a73e8efdbeca"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "24d6b39b-2623-4bea-80d4-c9c9dd1c8a19",
    "esbUUID": "a8a84e01-38d7-4965-92d8-ae106e562300",
    "desc": {
        "code": "ESB-360-S0000",
        "en": "Success",
        "ar": "نجاح"
    },
    "application": {
        "appIdentifier": {
            "applicationId": "19c73388-198b-49d3-90c1-1d48e6d6710c",
            "serviceId": "Service-1",
            "entityId": "RTA",
            "serviceName": "Tasty Wooden Towels",
            "serviceVersion": "v1"
        },
        "appState": {
            "en": "Pending",
            "ar": "التسمية العربية"
        },
        "appAudit": {
            "steps": [
                {
                    "seqNo": 1,
                    "type": "Info",
                    "rule": {
                        "en": "Consent To Apply",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "In Progress",
                        "ar": "التسمية العربية"
                    },
                    "initialUpdatedOn": "2013-09-13T16:02:36.905Z",
                    "lastUpdatedOn": "2001-01-23T20:28:06.061Z",
                    "initialUpdatedBy": "9",
                    "lastUpdatedBy": "5"
                },
                {
                    "seqNo": 2,
                    "type": "Info",
                    "rule": {
                        "en": "Pay To Apply",
                        "ar": "التسمية العربية"
                    },
                    "state": {
                        "en": "Pending",
                        "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": 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": "1",
                "en": "Repond Consent Request",
                "ar": "التسمية العربية"
            }
        ]
    }
}

🟠400Bad Request

🔴500Internal Server Error

Start My Application

Overview#

Sequence Diagram#

State Diagram#