Submitted to
Road & Transport Authority
Prepared By
Infosys Ltd
© COPYRIGHT
THIS DOCUMENT IS THE PROPERTY OF RTA
RTA_EIP_CMLNOCService_Specification
V1.0.docx
Version: 1.0
Oct 09 2014
Document Control Sheet
Document Meta Information
Document Type
CML NOC Service specification document
Document Title
RTA_EIP_CMLNOCService_SpecificationV1.1.docx
Created By
Infosys Limited
Created On
09-Oct–2014
Reviewed By
Vinod Uppinipurath
Reviewed On
09-Oct–2014
Release Date
09-Oct–2014
Version Control Information
Version
Release Date
Remarks
1.0
09–Oct–2014
Infosys Limited
Initial Version
1.1
29–May-2016
Infosys Limited
Added 5 new operations and updated
the existing operation ‘GetNOCDetails’.
Version: 1.0
Oct 09 2014
Table of Contents
Document Control Sheet …………………………………………………………………………………………………………. 2
1 Purpose ……………………………………………………………………………………………………………………………… 5
2 Functional Specification ……………………………………………………………………………………………………… 5
3 Technical specification ……………………………………………………………………………………………………….. 5
3.1 WSDL …………………………………………………………………………………………………………….. 5
4 Service Operations …………………………………………………………………………………………………………….. 6
4.1 getNOCDetails ……………………………………………………………………………………………….. 6
4.1.1 Operation Header ……………………………………………………………………………………. 6
4.1.2 Operation Request…………………………………………………………………………………… 6
4.1.3 Operation Response ……………………………………………………………………………….. 7
4.1.4 Operation Faults………………………………………………………………………………………. 9
4.1.5 Sample Message …………………………………………………………………………………….. 9
4.1.6 Response codes ……………………………………………………………………………………… 9
4.2 CancelNOC …………………………………………………………………………………………………….. 9
4.2.1 Operation Header ……………………………………………………………………………………. 9
4.2.1 Operation Request…………………………………………………………………………………. 10
4.2.2 Operation Response ……………………………………………………………………………… 10
4.2.3 Operation Faults…………………………………………………………………………………….. 10
4.2.4 Sample Message …………………………………………………………………………………… 10
4.2.5 Response codes ……………………………………………………………………………………. 10
4.3 ViewNOCDetails …………………………………………………………………………………………… 11
4.3.1 Operation Header ………………………………………………………………………………….. 11
4.3.1 Operation Request…………………………………………………………………………………. 11
4.3.2 Operation Response ……………………………………………………………………………… 12
4.3.3 Operation Faults…………………………………………………………………………………….. 12
4.3.4 Sample Message …………………………………………………………………………………… 12
4.3.5 Response codes ……………………………………………………………………………………. 13
4.4 UpdateNOCDetails ……………………………………………………………………………………….. 13
Version: 1.0
Oct 09 2014
4.4.1 Operation Header ………………………………………………………………………………….. 13
4.4.1 Operation Request…………………………………………………………………………………. 13
4.4.2 Operation Response ……………………………………………………………………………… 15
4.4.1 Operation Faults…………………………………………………………………………………….. 15
4.4.2 Sample Message …………………………………………………………………………………… 15
4.4.3 Response codes ……………………………………………………………………………………. 15
4.5 GetNOCTypes ………………………………………………………………………………………………. 15
4.5.1 Operation Header ………………………………………………………………………………….. 16
4.5.2 Operation Request…………………………………………………………………………………. 16
4.5.3 Operation Response ……………………………………………………………………………… 16
4.5.4 Operation Faults…………………………………………………………………………………….. 18
4.5.5 Sample Message …………………………………………………………………………………… 18
4.5.6 Response codes ……………………………………………………………………………………. 18
4.6 GetRequiredNOCTypes ………………………………………………………………………………… 18
4.6.1 Operation Header ………………………………………………………………………………….. 18
4.6.2 Operation Request…………………………………………………………………………………. 19
4.6.3 Operation Response ……………………………………………………………………………… 19
4.6.4 Operation Faults…………………………………………………………………………………….. 20
4.6.5 Sample Message …………………………………………………………………………………… 20
4.6.6 Response codes ……………………………………………………………………………………. 20
5 Non Functional Specifications …………………………..………………………………………………………………..20
5.1 Response Time …………………………………………………………………………………………….. 20
5.2 Volume …………………………………………………………………………………………………………. 20
5.3 Security …………………………………………………………………………………………………………. 21
5.4 Availability …………………………………………………………………………………………………….. 21
6 Service URL ……………………………………………………………………………………………………………………….21
7 Roles and responsibilities ……………………………………………………….………………………………………….21
8 Assumptions & Issues ………………………………………………………………………………………………………..21
8.1 General Assumptions ……………………………………………………………………………………. 21
9 References …………………………………………………………………………………………………………………………22
10 Definitions …………………………………………………………………………………………………………………………..22
11 Appendix…………………………………………………………………………………………………………………………….22
Version: 1.0
Oct 09 2014
1 Purpose
This document details CML NOC Service webservice specification. It contains details about the
operations included as part of this service along with its request and response parameters.
2 Functional Specification
CML NOC Service will be used by consumer applications to get/update/ search and cancel NOC
details info from eTraffic application.This is an automated way for the customer to accomplish his
transactions without the need for his presence in the eTraffic centers.
3 Technical specification
Service name
CML NOC Service
Service description
This service provides functionality to get/update/
search and cancel NOC details from eTraffic
application.
Security Info
Authentication (Username/pwd)
(& SSL for access from outside RTA)
Operations
1. GetNOCDetails
2. CancelNOC
3. ViewNOCDetails
4. UpdateNOCDetails
5. GetNOCTypes
6. GetRequiredNOCTypes
Binding Style
Document/literal
SOAP Faults
HTTP Client exception
HTTP Server exception
HTTP Communication exception
Activity Timed Out exception
3.1 WSDL
Version: 1.0
Oct 09 2014
4 Service Operations
4.1 getNOCDetails
This operation allows consumer applications to get NOC details from eTraffic application
4.1.1 Operation Header
Name
Type
Length
Optional
Description
ExternalUser
Complex Type
N/A
No
This element will be
passed as a SOAP
HEADER along with
WSSE security
header.
Name
Type
Length
Optional
Description
externalUsername
String
N/A
No
External user name
provided by eTraffic to
consumer application
externalUserPasswor
d
String
N/A
No
External password
provided by eTraffic to
consumer application
4.1.2 Operation Request
Name
Type
Length
Optional
Description
getNocDetailsInfoRe
quest
Complex
Type
N/A
No
Complex element. Root node
getNocDetailsInfoRequest
Name
Type
Length
Optional
Description
getNOCDetailsInfo
GetNocDetailsT
ype
N/A
No
Complex element.
GetNocDetailsType
Name
Type
Length
Optional
Description
trafficFileNo
Long
8
Yes
Traffic File No
eidNo
String
30
Yes
Eid No
tradeLicenseNo
String
8
Yes
Trade License No
plate
dubaiPlate
N/A
Yes
Plate Information
chassisNo
String
17
Yes
Chassis No
nocRefNo
String
128
Yes
Noc Ref No
nocType
Long
15
Yes
Noc Type
nocDateFrom
Date
N/A
Yes
Noc Date From
nocDateTo
Date
N/A
Yes
Noc Date To
nocStatus
Long
15
Yes
Noc Status
statusDateFrom
Date
N/A
Yes
Status Date From
statusDateTo
Date
N/A
Yes
Status Date To
Dubaiplate
Name
Type
Length
Optional
Description
plateNo
String
30
No
Plate No
plateCategory
String
30
No
plateCategory
plateCode
String
15
No
plateCode
4.1.3 Operation Response
getNOCDetailsResponse
Name
Type
Length
Optional
Description
getNocDetailsReturn
GetNocDe
tailsRespo
nseType
N/A
No
Complex
element root
node
GetNocDetailsResponseType
Name
Type
Length
Optional
Description
nocSearchResult
Noc Search
Result Type
N/A
Yes
Noc Search
Result
Type
Length
Optional
Description
Type
Node
Name
Type
Length
Optional
Description
s
Name
Type
Length
Optional
Description
messageEn
String
265
Yes
Message English
messageAr
String
265
Yes
Message Arabic
errorCode
String
15
Yes
Error Code