Service SRS document€¦ · Web viewThis document describes integration service provided from the Ejar platform to verify the tenancy status of an individual. It describes the business

Govt. Sector ServiceBy

EjarService Requirements & Specifications

Yesser e-Government Services

e-Government Program (Yesser)Ejar – Govt. Sector Services – Service Requirements &

Specifications

Document Description

Document Title Ejar - Govt. Sector Services – Service Requirements and

Specifications

Document Version 1.2

Document Status Draft

Record of Change

Ver. DateA = Add.M = Mod.D = Del.

By Revised Change Description

0.1 10 May 18 A Khalid Alotaibi Design the template

1.0 29 May 18 U First Draft

1.1 U Khalid Alotaibi update

1.2 9 Jul 18 U Faisal YasinUpdated during the

meeting

Confidential e-Government Program (Yesser)This document (either in whole or in part) cannot be modified or

reproduced without the prior written permission of the e-Government Program (Yesser)Page 2 / 19


Specifications

Table of Contents

1. Introduction..............................................................................................................41.1. Overview.............................................................................................................4

1.2. Definitions, Acronyms, and Abbreviations...........................................................4

1.3. Assumptions, Dependencies, and Constraints...................................................4

2. Governments Sector Services...............................................................................52.1. Get Tenancy Status for Individual.......................................................................5

2.1.1. Input...................................................................................................................................................... 6

2.1.1.1. Input enumerations...............................................................................................................................6

2.1.2. Result................................................................................................................................................... 7

2.1.2.1. Result enumerations.............................................................................................................................8

2.1.3. Errors.................................................................................................................................................... 8

2.2. Get Address for Individual...................................................................................9

2.2.1. Input.................................................................................................................................................... 10

2.2.1.1. Input enumerations.............................................................................................................................11

2.2.2. Result................................................................................................................................................. 12

2.2.3. Errors.................................................................................................................................................. 14

3. Non-Functional Requirements.............................................................................153.1. Service Quality..................................................................................................15

3.1.1. Performance.......................................................................................................................................15

3.1.2. Throughput.........................................................................................................................................15

3.2. Security.............................................................................................................16

3.3. Availability.........................................................................................................16

4. References.............................................................................................................175. Appendices............................................................................................................18

5.1. Appendix A: GSB Common Technical Errors...................................................18




Specifications

1. Introduction

1.1. OverviewThis document describes integration service provided from the Ejar platform to verify the

tenancy status of an individual. It describes the business purpose and detailed input and

output fields so that other system can use this service.

1.2. Definitions, Acronyms, and Abbreviations

Term Definition

WS Web Service

NIC National Information Center

API Application Programming Interface

NIN National Identification Number

DOB Date Of Birth

IG Integration Guide

Ejar Rental Contract Management System

MoH Ministry of Housing

1.3. Assumptions, Dependencies, and Constraints Tenancy Status can be retrieved only for the individual having National ID or

Iqama.




Specifications

2. Governments Sector Services

2.1. Get Tenancy Status for Individual

Des

crip

tion

This method is responsible for retrieving tenancy status for individual whose identification information is provided i.e. integrating system will provide the ID number and Ejar system will provide status for individual as true or false.

inpu

t

ID Type: Individual’s National ID, Iqama ID, Visitor ID, Other, GCC ID or GCC Passport

ID Number: Identification Number

Nationality: Nationality Code in case of GCC ID or GCC Passport

Res

ult




Tenancy Status: True in case Individual has an active contract in the Ejar System else False.

Bus

ines

s R

ules

An individual has an approved contract in the system with status Active where he is defined as Tenant.

An individual has an approved contract in the system with status Active where he is defined as Companion of Tenant.

Nationality Code is only required in case user provides GCC ID or GCC Passport




Specifications

Spec

ial

Not

es

If an individual registered a contract in the Ejar System for future dates than his tenancy status will not returned as true, unitl the contract reach its starting date and become active.

2.1.1. Input

Any application request to the getTenancyStatusOfIndividual method has to send

GetTenancyStatusOfIndividualRequest Objects.

The following table shows all the input parameters and the type of each parameter:

Input Element Name Description

ID Type Field: idType Type: Number

Length:10

Required: Yes Mandatory

Description: Identification Type

ID Number Field: idNumber Type: Number

Length:10


Description: ID Number of Individual

Nationality Field: nationalityCode Type: Number

Length:10

Required: Conditional (only required in case of ID

Type: GCC ID or GCC Passport)

Description: GCC Nationality

2.1.1.1. Input enumerations

Result Element Name Enumeration values

ID Type وطنية = 1 National ID هوية




Specifications

مقيم = 2 Iqama هوية

زيارة = 4 Visitor ID هوية

Other أخرى = 6

جواز - = 8 خليجية لدولة GCC مواطن

Citizen - Passport

وطنية - = 9 هوية خليجية لدولة مواطن

GCC Citizen - National ID

Nationality 101 = UAE

103 = Bahrain

106 = Oman

108 = Qatar

109 = Kuwait

2.1.2. Result

When getTenancyStatusOfIndividual method called, an object will be returned, which

is a complex type, that object is called GetTenancyStatusOfIndividualResponse.

The following tables show all the fields that will be returned from the

getTenancyStatusOfIndividual method.

Result Element Name Description

ID Type Field: idNumberType: Number

Length:10

Description: ID Type of Individual for which inquiry is




Specifications

performed

ID Number Field: idNumberType: Number

Length:10

Description: ID Number of Individual for which inquiry

is performed

Nationality Field: nationalityCodeType: Number

Length:10

Description: Nationality Code in case of Individual’s

GCC ID or GCC Passport is provided

Tenancy Status Field: tenancyStatusType: Boolean

Length:1

Description: Tenancy Status of the Individual

2.1.2.1. Result enumerations


Tenancy Status 1 or 0

Where 1 = true and 0 = false

2.1.3. Errors

Error Description (if needed) Category (B/T)

2002 ID number provided is invalid (INVALID_ID_NUMBER)

B




Specifications

2.2. Get Address for Individual

Des

crip

tion

This method is responsible for retrieving addresses for an individual whose identification information is provided i.e. integrating system will provide the ID number and Ejar system will provide addresses for an individual.

inpu

t




One of the two following :

Birth Date (Hijri): Birth Date in Hijri format for the individual is provided as a cross check.

Birth Date (Gregorian): Birth Date in Gregorian format for the individual is provided as a cross check.

Tenancy Contract No: Contract No. for one of the active contract of the individual




Specifications

Res

ult




List of Property National Address: A list of National addresses is retrieved which is composed of following elements:

City District Street Name Building Number Additional Number Postal Code

Bus

ines

s R

ules

An individual has an approved contract in the system with status Active where he is defined as Tenant.

An individual has an approved contract in the system with status Active where he is defined as Companion of Tenant.

Nationality Code is only required in case user provides GCC ID or GCC Passport

Contract No. for one of the active contract of the individual is provided as a cross check. In case contract No. is not available either Hijri or Gregorian birth date must be provided.

Spec

ial

Not

es

If an individual registered a contract in the Ejar System for future dates than his address is not returned unit the contract reach its starting date and become active.

2.2.1. Input

Any application request to the getAddressforIndividual method has to send

GetAddressforIndividualRequest Objects.

The following table shows all the input parameters and the type of each parameter:

Input Element Name Description

ID Type Field: idType Confidential e-Government Program (Yesser)

This document (either in whole or in part) cannot be modified or reproduced without the prior written permission of the e-Government Program (Yesser)

Page 10 / 19


Specifications

Type: Number

Length:10


Description: Identification Type

ID Number Field: idNumber Type: Number

Length:10


Description: ID Number of Individual

Nationality Field: nationalityCode Type: Number

Length:10

Required: Conditional (only required in case of ID

Type: GCC ID or GCC Passport)

Description: GCC Nationality

Tenancy Contract No. Field: tenancyContractNumberType: Number

Length:16

Required: Conditional

Description: Tenancy Contract No. in Ejar System for

the Individual

Birth Date Hijri Field: birthDateHijriType: Integer (YYYYMMDD)

Length:8


Description: Hijri Birth Date of the Individual

Birth Date Gregorian Field: birthDateGregorianType: Integer (YYYYMMDD)

Length:8


Description: Gregorian Birth Date of the Individual




Specifications

2.2.1.1. Input enumerations


ID Type وطنية = 1 National ID هوية

مقيم = 2 Iqama هوية

زيارة = 4 Visitor ID هوية

Other أخرى = 6

جواز - = 8 خليجية لدولة GCC مواطن

Citizen - Passport

وطنية - = 9 هوية خليجية لدولة مواطن

GCC Citizen - National ID

Nationality 101 = UAE

103 = Bahrain

106 = Oman

108 = Qatar

109 = Kuwait

2.2.2. Result

When GetAddressforIndividual method called, an object will be returned, which is a

complex type, that object is called GetAddressforIndividualResponse.

The following tables show all the fields that will be returned from the

getAddressforIndividual method.

Result Element Name Description

ID Type Field: idNumber




Specifications

Type: Number

Length:10

Description: ID Type of Individual for which inquiry is

performed

ID Number Field: idNumberType: Number

Length:10

Description: ID Number of Individual for which inquiry

is performed

Nationality Field: nationalityCodeType: Number

Length:10

Description: Nationality Code in case of Individual’s

GCC ID or GCC Passport is provided

List of Property National Address Field: cityType: String

Length:50

Description: City attribute of the address

Field: districtType: String

Length:50

Description: District attribute of the address

Field: streetNameType: String

Length:200

Description: Street Name attribute of the address

Field: buildingNumberType: Number

Length:4

Description: Building Number attribute of the address




Specifications

Field: additionalNumberType: Number

Length:4

Description: Additional Number attribute of the

address

Field: postalCodeType: Number

Length:5

Description: Postal Code attribute of the address

2.2.3. Errors

Error Description (if needed) Category (B/T)

2002 ID number provided is invalid (INVALID_ID_NUMBER)

B

2008At least one birth date is required or Tenancy Contract No.(DATE_OR_CONTRACT_NO_REQUIRED)

B




Specifications

3. Non-Functional Requirements

3.1. Service Quality

3.1.1. Performance

<Here list the Performance measures on all the services listed in this document. Note

this is already predefined as part of the agreed SLA and it is measured between

Yesser’s end point and the Provider’s end point. So the only thing to do here is to list

the operation and copying the average.>

Operation Average response time (per 10 call)400ms

3.1.2. Throughput

<Here the throughput of every service listed here must be recorded in the following

table. Note this is already predefined as part of the agreed SLA and it is measured

between Yesser’s end point and the Provider’s end point. So the only thing to do here is

to list the operation and throughput for every one of them>

Operation Throughput (transactions per Seconds)50 TPS




Specifications

3.2. Security<Much of the authentication and authorization is maintained by Yesser as access to the

GSB is totally maintained by it. Thus this section will emphasize on Yesser role in that

regard by using the next paragraph. And any security measure outside this scope

should be mentioned like the need for checksum, field encryption, or waiting for two

way authentication approval.>

The authentication process will be the responsibility of Yesser which is accomplished

using digital certificates and incorporating the WS-Security in the message header. As

for the authorization it will be incorporated into the GSB as the first level authorization

for the service in order to allow the eligible agencies to use the <Service Name>. The

<Provider Name> will also introduce a second level authorization that validates caller

eligibility with the facilitation of the Source ID in the SOAP header.

3.3. Availability<The availability of the service must be placed here. And since it is already predefined

in the agreed SLA then the following matrix should be duplicated for every operation?

Operation Availability (7x24)99.6%




Specifications

4. References

List all references here




Specifications

5. Appendices

5.1. Appendix A: GSB Common Technical Errors

Error Code Error Message Details Type

500-004001Client request message schema validation failure

For schema error that produced by the consumer in the request message

Example: NationalId value '10134963001' is not a valid instance of type NationalIdType

T

500-004002Provider reply schema validation failure

For schema error that produced by the provider in the response message.

T

500-004003SystemID not present in message

T

500-004004UserID not present in message

T

500-004005Authentication failure

T

500-004006 Authorization failure T

500-004007Failed to establish backend connection

T

500-004008"MessageID" not present in message

T

500-004008"Action" not present in message

T

500-004008"To" not present in message

T

500-004008"SourceID" not present in message

T

500-004008 "ServiceID" not T




Specifications

present in message

500-004009Message exceeded the limit

T

500-004010Mismatch "SourceID"

T

500-004011Attachment Validation Failure

T

500-004012Rejected by SLM Monitor

T

500-004013 Mismatch IP address

Indicates that the IP address used by the requesting entity is different than the one associate it with it in Yesser’s Active Directory.

T



Documents

Service SRS document€¦ · Web viewThis document describes integration service provided from the Ejar platform to verify the tenancy status of an individual. It describes the business