Skip to content

Commit b4840b4

Browse files
committed
Fix example code + rename /geturl endpoint (/search)
1 parent d7dd799 commit b4840b4

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/API/Using the API/Use-geturl.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
sidebar_position: 3
33
---
4-
# Using /geturl Endpoint
4+
# Using /search Endpoint
55

6-
In this tutorial, we will be using the /geturl endpoint to get a circular's download URL.
7-
The /geturl endpoint returns a string containing the download URL of the circular, taking the circular title as a parameter.
6+
In this tutorial, we will be using the /search endpoint to get a circular's download URL.
7+
The /search endpoint returns a string containing the download URL of the circular, taking the circular title as a parameter.
88

99
This endpoint returns a string (or None if not found) containing the download URL of the circular.
1010

@@ -22,18 +22,18 @@ Python
2222
```python
2323
import requests
2424

25-
url = "https://raj.moonball.io/bpsapi/v1/geturl/"
25+
url = "https://raj.moonball.io/bpsapi/v1/search/"
2626
payload = {'title': '2nd Parent Teacher Meeting (PTM) for Grades IX, X & XII'}
2727

2828
request = requests.get(url, json=payload)
29-
print(request.request)
29+
print(request.text)
3030
```
3131

3232
Curl
3333

3434
```bash
3535
curl -X 'GET' \
36-
'https://raj.moonball.io/bpsapi/v1/geturl/' \
36+
'https://raj.moonball.io/bpsapi/v1/search/' \
3737
-H 'accept: application/json' \
3838
-H 'Content-Type: application/json' \
3939
-d '{"title": "2nd Parent Teacher Meeting (PTM) for Grades IX, X & XII"}'

docs/API/Using the API/Use-latest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ url = "https://raj.moonball.io/bpsapi/v1/latest/"
3232
payload = {'category': 'ptm', "receive": "all"}
3333

3434
request = requests.get(url, json=payload)
35-
print(request.request)
35+
print(request.text)
3636
```
3737

3838
Curl

docs/API/Using the API/Use-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ url = "https://raj.moonball.io/bpsapi/v1/list/"
3232
payload = {'category': 'ptm', "receive": "all"}
3333

3434
request = requests.get(url, json=payload)
35-
print(request.request)
35+
print(request.text)
3636
```
3737

3838
Curl

0 commit comments

Comments
 (0)