Scribd
Upload
4 views7 pages

Department Dashboard API Integration Guide

The document outlines the API integration for displaying department application summaries on the RTS dashboard, detailing the process for obtaining a token and pushing department application details. It specifies the HTTP methods, API URLs, required headers, and the data structure for requests and responses. Additionally, it includes calculations for total applications received and disposed, along with the criteria for on-time delivery and pending applications.

Uploaded by

farukiamen5
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
4 views7 pages

Department Dashboard API Integration Guide

The document outlines the API integration for displaying department application summaries on the RTS dashboard, detailing the process for obtaining a token and pushing department application details. It specifies the HTTP methods, API URLs, required headers, and the data structure for requests and responses. Additionally, it includes calculations for total applications received and disposed, along with the criteria for on-time delivery and pending applications.

Uploaded by

farukiamen5
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Formatted: Right: 0 cm

Department Dashboard Integration

This API accepts the department's application summary to display on the RTS dashboard.

Test URL: [Link]

Get Request Token:


Provides token to be used in next API call

● HTTP Method: GET

● API URL: /api/Token/GetToken

Headers:

Header name Description

ClientSecretKey As provided by MahaIT team

DepartmentCode As provided by MahaIT team


Response:

data A token is returned after validating keys. This


token should be used further for pushing
summary data in the next API.

Snapshot : image showing response of GetToken API

Push Department Applications Details


● HTTP Method: POST

● API URL: /api/Dashboard/PushDepartmentDetails

Authorization Token: A valid Bearer token generated from the previous API is required for

authentication.

Snapshot: Showing how to provide authentication token

Request Details:
Property Name Data Type Sample Values Description

Department Text(100) Forest As provided by MahaIT


Team

5873
Service Number As provided by MahaIT
Team

6
Division Number As master data provided by
MahaIT Team

520
District Number As master data provided by
MahaIT Team

4173
Taluka Number As master data provided by
MahaIT Team

100 Total approved applications


Approved Number count

5 Total rejected applications


Rejected Number count

50 Applications count delivered


OnTimeDelivery Number within service SLA

10 Applications count pending


PendingatUser Number with citizen

20 Applications count pending


PendingatDepartment Number at department

55 Applications count delivered


NotOnTimeDelivery Number after service SLA
PG / NA Pass PG for payment
PaymentMode Text(2) gateway or else NA

U/D U for Aaple Sarkar and


ApplicationSource Text(1) D for Forest Department or
respective department

2024 YYYY year in which the


Year Number application is received.

8 1 to 12 Month of application
Month Number

Total Applications Received = Approved + Rejected + Pending@User + Pending@Department

Total Disposed = Approved + Rejected

Pending@User = Total Disposed - Pending@Department

OnTimeDeliver = Total Disposed - NotOnTimeDelivery


Snapshot: API request

Snapshot: API request

Response :
status true / false
True : when no errors
False: when any errors while saving data

message Blank when no errors. Error details in case of errors.

Snapshot: Showing response of API

You might also like