- Component Diagram
- S360 Providers
- BackOffice Workspace
- IID Authorization
- MDM
- S360
- BackOffice
- IID Portal
- Read This First
- Application Status
- Services
- Applications
- Inventory
- Payment
- Document
- Application Workspace
- Rules Engines
- Payment
Get My Services
Integrating
POST
https://s360-service-apiqa.detsandbox.com/services/v1
Last modified:2024-10-03 01:02:31
OperationId:GetMyServices
Overview#
Sequence Diagram#
PreCondition:
Investor is authenticated in IID Portal.
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.
API Specification#
Request
Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************Header Params
Body Params application/json
Example
{
"requestControl": {
"returnIneligible": true,
"returnCompatibility": true,
"returnComposeOf": true,
"returnEligibility": true,
"returnExecRules": true,
"returnPolicy": true,
"returnBusinessEvents": true,
"returnApplicationInstances": true,
"returnInventoryInstances": true,
"forceCacheRefresh": true,
"limit": 10,
"page": 1
},
"query": {
"dulNumber": [
"DUL0001",
"DUL0002",
"DUL0003"
],
"legalEntityId": "70302",
"situation": [
"NewBusiness"
]
}
}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-service-apiqa.detsandbox.com/services/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": {
"returnIneligible": true,
"returnCompatibility": true,
"returnComposeOf": true,
"returnEligibility": true,
"returnExecRules": true,
"returnPolicy": true,
"returnBusinessEvents": true,
"returnApplicationInstances": true,
"returnInventoryInstances": true,
"forceCacheRefresh": true,
"limit": 10,
"page": 1
},
"query": {
"dulNumber": [
"DUL0001",
"DUL0002",
"DUL0003"
],
"legalEntityId": "70302",
"situation": [
"NewBusiness"
]
}
}'Responses
🟢200Success
application/json
Body
Example
{
"status": 200,
"externalId": "7c4a10c0-0198-4d61-b9e7-c7e5a18cd2d4",
"esbUUID": "039b71a3-ef68-4333-9dc0-43fa9edd9eb9",
"desc": {
"code": "ESB-360-S0000",
"en": "Success",
"ar": "التسمية العربية"
},
"services": [
{
"id": "Service-1",
"name": "Service-1",
"shortDesc": {
"en": "Short desc for Service 1",
"ar": "التسمية العربية"
},
"longDesc": {
"en": "Long desc for Service 1",
"ar": "التسمية العربية"
},
"version": "1.0",
"provider": {
"code": "RTA",
"en": "Road and Transport Authority",
"ar": "التسمية العربية"
},
"type": {
"en": "Permit",
"ar": "التسمية العربية"
},
"sectors": [
{
"en": "Logistic and Transport",
"ar": "التسمية العربية"
}
],
"composedOf": [
{
"id": "Service-1A",
"autoStart": false,
"sequence": 1
},
{
"id": "Service-1B",
"autoStart": false,
"sequence": 2
}
],
"compatibilities": [
{
"lifecycle": "Normal",
"segments": [
{
"segmentCompatibleWith": [
{
"context": "DUL.TradeLicense.Activity",
"value": [
{
"code": "90001",
"en": "Transportation",
"ar": "التسمية العربية"
},
{
"code": "90002",
"en": "Car Rental",
"ar": "التسمية العربية"
}
]
},
{
"context": "DUL.TradeLicense.IsMainLicense",
"value": [
{
"code": "true",
"en": "True",
"ar": "التسمية العربية"
}
]
}
],
"segmentIncompatibleWith": [
{
"context": "DUL.TradeLicense.Status",
"value": [
{
"code": "Inactive",
"en": "Inactive",
"ar": "التسمية العربية"
}
]
}
]
}
]
}
],
"eligibilities": [
{
"lifecycle": "Normal",
"serviceRequiredFor": [
"Service-2"
],
"serviceIncompatibleWith": [
"Service-3"
]
}
],
"execRules": [
{
"lifecycle": "Normal",
"rules": [
{
"name": "Acceptance",
"value": "ConsentRequired",
"seqNo": 1
},
{
"name": "Acceptance",
"value": "PaymentRequired",
"seqNo": 2
},
{
"name": "Submission",
"value": "ConsentRequired",
"seqNo": 3
},
{
"name": "Submission",
"value": "PaymentRequired",
"seqNo": 4
},
{
"name": "Approval",
"value": "DecisionRequired",
"seqNo": 5
},
{
"name": "Fulfilment",
"value": "PaymentRequired",
"seqNo": 6
}
]
}
],
"policy": {
"inventory": [
{
"policyItem": "IsRenewable",
"policyValue": "true"
},
{
"policyItem": "DaysRenewalApplicationStart",
"policyValue": "7"
},
{
"policyItem": "DaysReminderExpiration",
"policyValue": "7"
},
{
"policyItem": "IsAllowRenewAfterExpired",
"policyValue": "false"
},
{
"policyItem": "DaysAllowRenewAfterExpired",
"policyValue": "30"
},
{
"policyItem": "IsAmendable",
"policyValue": "true"
},
{
"policyItem": "IsAmendable",
"policyValue": "true"
},
{
"policyItem": "DaysAmendmentApplicationStart ",
"policyValue": "1"
},
{
"policyItem": "MaxInstances ",
"policyValue": "2"
}
],
"application": [
{
"policyItem": "MaxInstances ",
"policyValue": "2"
}
],
"applicationTrigger": [
{
"policyItem": "IsAllowedBusinessEvent",
"policyValue": "true"
},
{
"policyItem": "IsAllowedOnDemand",
"policyValue": "false"
}
],
"businessEvents": [
"DUL.TradeLicense.Issued"
]
},
"situations": [
{
"code": "NewBusiness",
"name": {
"en": "Practice Your New Business",
"ar": "التسمية العربية"
},
"shortDesc": {
"en": "These are activities recommended to start your new business",
"ar": "التسمية العربية"
}
}
]
}
],
"tradeLicenses": [
{
"dulNumber": "DUL0001",
"serviceId": "Service-1",
"state": {
"en": "Eligible",
"ar": "التسمية العربية"
},
"availableActions": [
{
"code": "0",
"en": "Start My Application",
"ar": "التسمية العربية"
}
],
"application": {
"instances": [
{
"id": "1433dd2c-ef3c-4568-afdf-d893bb51e894",
"state": {
"en": "Submitted",
"ar": "التسمية العربية"
},
"audit": {
"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
},
"availableActions": [
{
"code": "7",
"en": "View My Application",
"ar": "التسمية العربية"
}
]
}
],
"max-instances": 2
},
"inventory": {
"instances": [
{
"id": "1433dd2c-ef3c-4568-afdf-d893bb51e123",
"state": {
"en": "Provisioned",
"ar": "التسمية العربية"
},
"provisionedOn": "2024-05-16T06:16:33.004Z",
"expiredOn": "2025-05-16T00:00:00.000Z",
"availableActions": [
{
"code": "10",
"en": "View Activity Output",
"ar": "التسمية العربية"
}
],
"outputs": [
{
"id": "79ff6ec2-0eb6-4d5e-8297-d4fd04020090",
"docType": "Permit",
"fileType": "pdf",
"fileName": "anenst_precious.pdf"
}
]
}
],
"max-instances": 2
}
}
]
}🟢202Accepted
🟠400Bad Request
🔴500Internal Server Error
Modified at 2024-10-03 01:02:31