-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
277 lines (265 loc) · 10.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!--
API Documentation HTML Template - 1.0.0
Copyright © 2016 Florian Nicolas
Licensed under the MIT license.
https://github.com/ticlekiwi/API-Documentation-HTML-Template
!-->
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8">
<title>RAIL API | Documentation</title>
<meta name="description" content="">
<meta name="author" content="ticlekiwi">
<meta http-equiv="cleartype" content="on">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/hightlightjs-dark.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,500|Source+Code+Pro:300" rel="stylesheet">
<link rel="stylesheet" href="css/style.css" media="all">
<script>
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<div class="left-menu">
<div class="content-logo">
<img alt="platform by Emily van den Heever from the Noun Project"
title="platform by Emily van den Heever from the Noun Project" src="images/logo.png" height="32" />
<span>RAIL Documentation</span>
</div>
<div class="content-menu">
<ul>
<li class="scroll-to-link active" data-target="get-started">
<a>GET STARTED</a>
</li>
<li class="scroll-to-link" data-target="get-characters">
<a>Get Characters</a>
</li>
<!-- <li class="scroll-to-link" data-target="errors">
<a>Errors</a>
</li> -->
</ul>
</div>
</div>
<div class="content-page">
<div class="content-code"></div>
<div class="content">
<div class="overflow-hidden content-section" id="content-get-started">
<h1 id="get-started">Get started</h1>
<pre>
API Endpoint
https://pnr-status-indian-railway.p.rapidapi.com/rail
</pre>
<p>
The Rail PNR API provides programmatic access to read Railway PNR status data. Retrieve passenger
information and journey information, provide an oauth connexion, retrieve a familly, filter them,
etc.
</p>
<p>
To use this API, you need an <strong>API key</strong>. Please contact us at <a
href="mailto:[email protected]">[email protected]</a> or visit <a
href="https://rapidapi.com/dev2919/api/pnr-status-indian-railway">Vendor Website</a> to get your
own API key.
</p>
</div>
<div class="overflow-hidden content-section" id="content-get-characters">
<h2 id="get-characters">get characters</h2>
<pre><code class="bash">
# Here is a pure Javascript fetch example
fetch("https://pnr-status-indian-railway.p.rapidapi.com/rail/8531575878", {
"method": "GET",
"headers": {
"x-rapidapi-host": "pnr-status-indian-railway.p.rapidapi.com",
"x-rapidapi-key": "<< YOUR API KEY HERE >>"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.log(err);
});
</code></pre>
<p>
To get characters you need to make a GET call to the following url :<br>
<code class="higlighted">https://pnr-status-indian-railway.p.rapidapi.com/rail</code>
</p>
<br>
<pre><code class="json">
Result example :
{10 items
"arrival_data":{2 items
"arrival_date":"Tue, 09 Jun 04:45",
"arrival_time":"Tue, 09 Jun 04:45",
}
"boarding_station":"Bhusaval Junction-BSL",
"chart_status":"Chart Prepared",
"class":"3A",
"departure_data":{2 items
"departure_date":"Sun, 07 Jun 06:25",
"departure_time":"Sun, 07 Jun 06:25",
}
"passenger":[4 items
0:{3 items
"booking_status":"W/L 6,RLGN",
"current_status":"CNF B2 1",
"name":"Passenger 1"
}
1:{3 items
"booking_status":"W/L 7,RLGN",
"current_status":"CNF B2 4",
"name":"Passenger 2"
}
2:{3 items
"booking_status":"W/L 8,RLGN",
"current_status":"RLWL 1",
"name":"Passenger 3"
}
3:{3 items
"booking_status":"W/L 9,RLGN",
"current_status":"RLWL 2"
"name":"Passenger 4"
}
]
"quota":"",
"reservation_upto":"Patliputra Junction-PPTA",
"train_name":"LTT PPTA SPL-02141",
"train_number":"LTT PPTA SPL-02141",
}
</code></pre>
<h4>REQUEST PARAMETERS</h4>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>secret_key</td>
<td>String</td>
<td>Your API key.</td>
</tr>
<tr>
<td>PNR No.</td>
<td>String</td>
<td>(Required) A key number to find journey information.</td>
</tr>
<tr>
<td>Train number</td>
<td>String</td>
<td>
(optional - will be added soon) Live track and schedule of train journey
</td>
</tr>
<tr>
<td>x-rapidapi-host</td>
<td>String</td>
<td>
x-rapidapi-host key
</td>
</tr>
</tbody>
</table>
</div>
<div class="overflow-hidden content-section" id="content-errors">
<h2 id="errors">RAIL-API </h2>
<p>
By <a href="https://dev2919.github.io/" target="_blank">Devesh Pawar</a> & <a href="https://javkarprajeesh.github.io/Portfolio/index.html" target="_blank">Prajeesh Javkar</a> © 2020.<br>
This API is intented for educational purpose only. Use this
API at your own discretion.
</p>
<!-- <table>
<thead>
<tr>
<th>Error Code</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td>X000</td>
<td>
Some parameters are missing. This error appears when you don't pass every mandatory
parameters.
</td>
</tr>
<tr>
<td>X001</td>
<td>
Unknown or unvalid <code class="higlighted">secret_key</code>. This error appears if you
use an unknow API key or if your API key expired.
</td>
</tr>
<tr>
<td>X002</td>
<td>
Unvalid <code class="higlighted">secret_key</code> for this domain. This error appears
if you use an API key non specified for your domain. Developper or Universal API keys
doesn't have domain checker.
</td>
</tr>
<tr>
<td>X003</td>
<td>
Unknown or unvalid user <code class="higlighted">token</code>. This error appears if you
use an unknow user <code class="higlighted">token</code> or if the user <code
class="higlighted">token</code> expired.
</td>
</tr>
</tbody>
</table> -->
</div>
</div>
<div class="content-code"></div>
</div>
<!-- Github Corner Ribbon - to remove (Ribbon created with : http://tholman.com/github-corners/ )-->
<a href="https://github.com/dev2919" class="github-corner"
aria-label="View source on Github" title="View source on Github"><svg width="80" height="80"
viewBox="0 0 250 250"
style="z-index:99999; fill:#70B7FD; color:#fff; position: fixed; top: 0; border: 0; right: 0;"
aria-hidden="true">
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
<path
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
<path
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
fill="currentColor" class="octo-body"></path>
</svg></a>
<style>
.github-corner:hover .octo-arm {
animation: octocat-wave 560ms ease-in-out
}
@keyframes octocat-wave {
0%,
100% {
transform: rotate(0)
}
20%,
60% {
transform: rotate(-25deg)
}
40%,
80% {
transform: rotate(10deg)
}
}
@media (max-width:500px) {
.github-corner:hover .octo-arm {
animation: none
}
.github-corner .octo-arm {
animation: octocat-wave 560ms ease-in-out
}
}
</style>
<!-- END Github Corner Ribbon - to remove -->
<script src="js/libs/jquery.js"></script>
<script src="js/script.js"></script>
</body>
</html>