Overview

This component provides references to license profile by querying mdm database replica

Sequence Diagram

DUL Query

Query to get License Field

SELECT l.DBN as dulNumber, l.IssueAuthority_ as issueAuthority ,l.IsMainLicence as isMainLicense,l.Category_ as category,l.ActivityType_ as activityType,stLi.EnglishName as status
FROM (SELECT * FROM tibco_ebx.dbo.EBX_REPLICA_Licence WHERE DBN in (?)) as l
LEFT JOIN tibco_ebx.dbo.EBX_REPLICAREF_LicenceStatus stLi (nolock) on stLi.ID = l.Status_;

Mapping

DB Output	Map to Context	Remarks
issueAuthority	DUL.TradeLicense.IssueAuthority	As is
isMainLicense	DUL.TradeLicense.IsMainLicense	Convert to "true" / "false"
category	DUL.TradeLicense.Category	As is
activityType	DUL.TradeLicense.ActivityType	As is
status	DUL.TradeLicense.Status	As is

Query to get License Company Activities

SELECT li.DBN as dulNumber,COALESCE(ca.ActivityIssueAuthority__ActivityCode,'') as activity 
FROM (SELECT DBN,Company_ FROM tibco_ebx.dbo.EBX_REPLICA_Licence WHERE DBN in (?)) as li
left join tibco_ebx.dbo.EBX_REPLICA_CompanyActivity ca (nolock) on ca.Company_ = li.Company_;

Mapping

DB Output	Map to Context	Remarks
activity	DUL.TradeLicense.Activity	Group by dulNumber and map as array of values

Note
Replace query parameter in "WHERE DBN in (?)" with dulNumbers coming in the request

API Specification

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "4917a9ac-9f30-4262-83b4-eeee261259f7",
    "esbUUID": "34f7da02-afab-4f55-ac90-f4633b41a8f3",
    "desc": {
        "code": "47547",
        "en": "Success",
        "ar": "نجاح"
    },
    "licenses": [
        {
            "dulNumber": "DUL0001",
            "profiles": [
                {
                    "context": "DUL.TradeLicense.IssueAuthority",
                    "values": [
                        "1"
                    ]
                },
                {
                    "context": "DUL.TradeLicense.IsMainLicense",
                    "values": [
                        "true"
                    ]
                },
                {
                    "context": "DUL.TradeLicense.Category",
                    "values": [
                        "83"
                    ]
                },
                {
                    "context": "DUL.TradeLicense.ActivityType",
                    "values": [
                        "2"
                    ]
                },
                {
                    "context": "DUL.TradeLicense.Status",
                    "values": [
                        "Active"
                    ]
                },
                {
                    "context": "DUL.TradeLicense.Activity",
                    "values": [
                        "4771919",
                        "4773204",
                        "4771110",
                        "4751001",
                        "4771201",
                        "4764001",
                        "4772007",
                        "4773106",
                        "4741001"
                    ]
                }
            ]
        }
    ]
}

QueryLicenses

Overview#

Sequence Diagram#

DUL Query#

Query to get License Field#

Mapping#

Query to get License Company Activities#

Mapping#

API Specification#

Request

Request Code Samples

Responses

Overview

Sequence Diagram

DUL Query

Query to get License Field

Mapping

Query to get License Company Activities

Mapping

API Specification