Interface Document for API Based Data

Exchange with Bank Ver 1.6

Vidya Lakshmi

Protean eGov Technologies

Limited (Formerly NSDL
e-Governance Infrastructure
Limited), Mumbai

January 25, 2023

1
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

1. API for Banks to get list of Files available to download


Banks to make an API call to Vidya Lakshmi Portal and provide username and
password.

After authentication, Vidya Lakshmi Portal will provide list of files available to be
transferred to that bank.

1.1 Input Parameters

Input parameters should be passed as request parameter while making

HTTPS call to web service through GET method

Sr.no Input Parameters Data Type Data Length

1 userid(i.e: email- String 254
id)
2 password String 500

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/getPendingRecords

1.2 Response Parameters

System will provide a String array consisting list of File Id’s of respective files
pending for download.

Sr. No Field Name Data Type Remarks

1 Array Object It Contains comma separated list of File
id’s

1.3 Sample JSON String of Response:

[“Fileid1”, “FileId2”, “FileId3”]

2
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

2. API for Banks to get download the Files


Bank to make an API call and provide username, password and one File ID at a time as
parameters.

After authentication, Vidya Lakshmi Portal will provide Actual ZIP file as response.

2.1 Input Parameters

Input parameters should be passed as request parameter while calling API

to download Zip File

Sr.no Input Data Type Data Length

Parameters
1 userid String 254
2 password String 500
3 fileid String 50

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/getPendingRecordF
ile

3. API for Banks to upload Response Files


Bank to make an API call and provide username, password and XML file to be uploaded as
parameters.

After authentication, Vidya Lakshmi Portal will provide file reference ID as response which
can be used by Bank to know the status of file uploaded.

3.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method

3
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 file (XML File To be File -
Uploaded)

URL: https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/uploadResponse

3.2 Response

Vidya Lakshmi Portal will return a String as response having File
Reference Id as output.

4. API for Banks to know status of Response Files uploaded


Bank to make an API call and provide username, password and File Reference ID as
parameters.

After authentication, Vidya Lakshmi Portal will provide status of the file.

4.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through GET method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/getResponseStatus

4
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

4.2 Response


Call to above URL will return a String as response status (“Accepted/
Rejected/ Partially Accepted”) as output.

In case of Rejected/ Partially Accepted Status an error HTML file will be
downloaded.

5. API for Banks to upload New Offline Applications


Bank to make an API call and provide username, password and compressed File(extension -
.ZIP) as parameters.

After authentication, Vidya Lakshmi Portal will provide file reference ID as response which
can be used by Bank as a reference to know the status of file uploaded.

5.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
ZIP file (CSV/XML File To be
3 Uploaded) File -

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/uploadNewFile_Offli
ne

5.2 Response


Vidya Lakshmi Portal will return a json formatted response

Json format as follows –
i. responseCode – eg contains values such as “1000”/ “1001”/
“1002”/ “1003”etc. each code represents a response(error
code & description mappings listed at the end of the

5
Vidya Lakshmi Confidential API Interface Document Ver. 1.6
document) generated on success/failure events.
ii. filename – uploaded file Name
iii. fileId – contains generated file id (only if file upload is successful)
else will have value “0”
iv. fileStatus - “Z” (default char).

Sample json response:

{"responseCode":"1000","fileName":"abc.xml.zip","fileId":"1257","fileStatus":"
Z"}

6. API for Banks to know status of uploaded New Offline Applications Files

Bank to make an API call and provide username, password and File Reference ID as
parameters.

After authentication, Vidya Lakshmi Portal will provide file’s status.

6.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through GET method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

URL: https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/getFileStatus

6.2 Response


Call to above URL will return a json formatted response status (“A / R /
P”) as output.
(“A- Accepted/ R- Rejected/ P- Partially Accepted”)

In case of status as R- Rejected/ P- Partially Accepted next service needs
to be invoked for downloading the error file (.html)

Json format as follows –

6
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

i. responseCode – eg contains values such as “1000”/ “1001”/

“1002”/ “1003”etc. each code represents a response(error code & description
mappings listed at the end of the document) generated on success/failure
events.
ii. filename – “NA”
iii. fileId – contains passed parameter file id value
iv. fileStatus - “A / R / P” (valid fileID), “Z” (default char).

Sample json response :

{"responseCode":"1000","fileName":"NA","fileId":"1257","fileStatus":"A"}

7. API for Banks to download the generated error file against the uploaded New
Offline Applications Files


Bank to make an API call and provide username, password and File Reference ID as
parameters.

After authentication, Vidya Lakshmi Portal will respond with error file (.html) for the provided
valid fileId(having status - R- Rejected/ P- Partially Accepted).

7.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through GET method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

URL: https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/getErrorFile

7.2 Response

Call to above URL will return an error file (.html)

In case of invalid fileId provided, API returns a json formatted response
as output.

7
Vidya Lakshmi Confidential API Interface Document Ver. 1.6


If API is able to successfully provide the error file then, the response
header will contain a property- “errorFileName”(contains value as
generated error file’s name). In case of failure, the header will not
contain the property- “errorFileName”.


Json format as follows –
i. responseCode – eg contains values such as “1000”/ “1001”/
“1002”/ “1003”etc. each code represents a response(error code & description
mappings listed at the end of the document) generated on success/failure
events.
ii. filename – “NA”
iii. fileId – contains passed parameter file id value
iv. fileStatus - “Z”(default char).

Sample json response :

{"responseCode":"1004","fileName":"NA","fileId":"1257","fileStatus":"Z"}

Note: After uploading response file kindly wait for 15 minutes before executing response
webservice.

8. API for Banks to get list of Files available to download (Method = POST)

 Banks to make an API call to Vidya Lakshmi Portal and provide

username and password as Json body parameter.

 After authentication, Vidya Lakshmi Portal will provide list of files available
to be transferred to that bank.

8.1 Input Parameters

Input parameters should be passed as Json body parameter while making

HTTPS call to web service through POST method.

8
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

Sr.no Input Parameters Data Type Data Length

1 userid(i.e: email- String 254
id)
2 password String 500

Sample Json body for Input parameter:

{"userid":"abcd","password":"abcd"}

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postPendingRecord
s

8.2 Response Parameters

System will provide a String array consisting list of File Id’s of respective files pending
for download.

Sr. No Field Name Data Type Remarks

1 Array Object It Contains comma separated list of File
id’s

8.3 Sample JSON String of Response:

[“Fileid1”, “FileId2”, “FileId3”]

9. API for Banks to get download the Files (Method = POST)

 Bank to make an API call and provide username, password and one File ID at a time
as Json body parameters.

 After authentication, Vidya Lakshmi Portal will provide Actual ZIP file as response.

9.1 Input Parameters

Input parameters should be passed as Json body parameter while calling API
to download Zip File

9
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

Sr.no Input Data Type Data Length

Parameters
1 userid String 254
2 password String 500
3 fileid String 50

Sample Json body for Input parameter:

{"userid":"abcd","password":"abcd","fileid":"abcd"}

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postPendingRecord
File

10. API for Banks to upload Response Files (Method = POST)

 Bank to make an API call and provide username, password and XML file to be
uploaded as form data parameters.

 After authentication, Vidya Lakshmi Portal will provide file reference ID as

response which can be used by Bank to know the status of file uploaded.

10.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method

Data
Sr.no Input Parameters Data Length
Type
bodyParam
1 String -
(userid,password)
file (XML File To be
2 File -
Uploaded)

10
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

Sample json body for Input parameter bodyParam :

{"userid":"abcd","password":"abcd"}

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postUploadResponse

10.2 Response


Vidya Lakshmi Portal will return a String as response having File
Reference Id as output.

11. API for Banks to know status of Response Files uploaded (Method = POST)

 Bank to make an API call and provide username, password and File Reference ID as
Json body parameters.
 After authentication, Vidya Lakshmi Portal will provide status of the file.

11.1 Input Parameters

Input parameters should be passed as Json body parameter while making HTTPS
call to web service through POST method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

Sample Json body for Input parameter:

{"userid":"abcd","password":"abcd","fileRefId":"abcd"}

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postResponseStatus

11
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

11.2 Response


Call to above URL will return a String as response status
(“Accepted/ Rejected/ Partially Accepted”) as output.


In case of Rejected/ Partially Accepted Status an error HTML file will
be downloaded.

12. API for Banks to upload New Offline Applications (Method = POST)

 Bank to make an API call and provide username, password and compressed File
(extension - .ZIP) as form data parameters.
 After authentication, Vidya Lakshmi Portal will provide file reference ID as
response which can be used by Bank as a reference to know the status of file
uploaded.

12.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method.

Input Parameters Data Type Data Length

Sr.no
1 bodyParam (userid,password) String -

ZIP file (CSV/XML File To be

2 File -
Uploaded)

Sample json body for Input parameter bodyParam :

{"userid":"abcd","password":"abcd"}

URL:
https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postUploadNewFile
_Offline

12
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

12.2 Response


Vidya Lakshmi Portal will return a json formatted response

Json format as follows –

i. responseCode – eg contains values such as “1000”/ “1001”/

“1002”/ “1003”etc. each code represents a response(error code &
description mappings listed at the end of the document) generated on
success/failure events.
ii. filename – uploaded file Name
iii. fileId – contains generated file id (only if file upload is
successful) else will have value “0”
iv. fileStatus - “Z” (default char).

Sample json response:

{"responseCode":"1000","fileName":"abc.xml.zip","fileId":"1257",
"fileStatus":"Z"}

13. API for Banks to know status of uploaded New Offline Applications Files
(Method = POST)

 Bank to make an API call and provide username, password and File Reference ID as
Json body parameters.
 After authentication, Vidya Lakshmi Portal will provide file’s status.

13.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

13
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

Sample Json body for Input parameter:

{"userid":"abcd","password":"abcd","fileRefId":"abcd"}

URL: https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postFileStatus

13.2 Response


Call to above URL will return a json formatted response status (“A
/ R / P”) as output.

(“A- Accepted/ R- Rejected/ P- Partially Accepted”)


In case of status as R- Rejected/ P- Partially Accepted next service
 needs to be invoked for downloading the error file (.html)
Json format as follows –

i. responseCode – eg contains values such as “1000”/ “1001”/

“1002”/ “1003”etc. each code represents a response(error code &
description mappings listed at the end of the document) generated on
success/failure events.
ii. filename – “NA”
iii. fileId – contains passed parameter file id value
iv. fileStatus - “A / R / P” (valid fileID), “Z” (default char).

Sample json response :

{"responseCode":"1000","fileName":"NA","fileId":"1257","fileStatus":"A"}

14. API for Banks to download the generated error file against the uploaded New
Offline Applications Files (Method = POST)

 Bank to make an API call and provide username, password and File Reference ID as
Json body parameters.
 After authentication, Vidya Lakshmi Portal will respond with error file (.html) for the
provided valid fileId(having status - R- Rejected/ P- Partially Accepted).

14
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

14.1 Input Parameters

Input parameters should be passed as request parameter while making HTTPS

call to web service through POST method

Sr.no Input Parameters Data Type Data Length

1 userid String 254
2 password String 500
3 fileRefId String -

Sample Json body for Input parameter:

{"userid":"abcd","password":"abcd","fileRefId":"abcd"}

URL: https://www.vidyalakshmi.co.in/RestFileDownloadAPI/service/postErrorFile

14.2 Response


Call to above URL will return an error file (.html)


In case of invalid fileId provided, API returns a json formatted
response as output.


If API is able to successfully provide the error file then, the
response header will contain a property- “errorFileName”(contains
value as generated error file’s name). In case of failure, the header
will not contain the property- “errorFileName”.


Json format as follows –

i. responseCode – eg contains values such as “1000”/ “1001”/

“1002”/ “1003”etc. each code represents a response(error code &
description mappings listed at the end of the document) generated on
success/failure events.
ii. filename – “NA”
iii. fileId – contains passed parameter file id value

15
Vidya Lakshmi Confidential API Interface Document Ver. 1.6

iv. fileStatus - “Z”(default char).

Sample json response :

{"responseCode":"1004","fileName":"NA","fileId":"1257","fileStatus":"Z"}

API Error Code and Description

1000 Success. API hit success

1001 User Authentication Failure. Incorrect user

credentials provided.

1002 Invalid File Name. incorrect naming

convention provided for the file uploaded

1003 File has already been uploaded. Please change

file name and try again. File with same name
has already been uploaded. Kindly change
filename and then upload.

1004 fileRefID does not exist in System. Provided

fileRefId not present in system

1005 Invalid fileRefID. Incorrect fileRefId provided.

1006 Error file not found on server. Error response

file not present on server.

1007 Error file entry not found in the table. Error

response file entry not present in database.

1008 Exception while processing request

16