1. Overview
Google sheets backend
1.1. Version information
Version: 1.5.0
1.2. Contact information
Contact: Mike Ralphson Contact Email: mike.ralphson@gmail.com
1.3. URI scheme
Host: nitro.apispark.net BasePath: /v1 Schemes: HTTPS
1.4. Tags
-
Default: Default section
-
Nitro Data: Imported from Nitro Data
2. Paths
2.1. Loads a list of programme
GET /programmes/
2.1.1. Description
Loads a list of programme
2.1.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
thumbnail |
false |
string |
||
QueryParameter |
guidance |
false |
string |
||
QueryParameter |
available |
false |
string |
||
QueryParameter |
episode |
false |
string |
||
QueryParameter |
name |
false |
string |
||
QueryParameter |
duration |
false |
string |
||
QueryParameter |
web |
false |
string |
||
QueryParameter |
$page |
Number of the page to retrieve. Integer value. |
false |
string |
|
QueryParameter |
index |
false |
string |
||
QueryParameter |
timeadded |
false |
string |
||
QueryParameter |
$size |
Size of the page to retrieve. Integer value |
false |
string |
|
QueryParameter |
episodenum |
false |
string |
||
QueryParameter |
seriesnum |
false |
string |
||
QueryParameter |
$sort |
Order in which to retrieve the results. Multiple sort criteria can be passed. Example: sort=age ASC,height DESC |
false |
string |
|
QueryParameter |
categories |
false |
string |
||
QueryParameter |
type |
false |
string |
||
QueryParameter |
pid |
false |
string |
||
QueryParameter |
versions |
false |
string |
||
QueryParameter |
desc |
false |
string |
||
QueryParameter |
channel |
false |
string |
2.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
[programme] array |
400 |
Error 400 |
No Content |
2.1.4. Produces
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.1.5. Tags
-
Nitro Data
2.2. Adds a programme
POST /programmes/
2.2.1. Description
Adds a programme
2.2.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
BodyParameter |
body |
false |
2.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
2.2.4. Consumes
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.2.5. Produces
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.2.6. Tags
-
Nitro Data
2.3. Loads a programme
GET /programmes/{programmeid}
2.3.1. Description
Loads a programme
2.3.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
programmeid |
Identifier of the programme |
true |
string |
2.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
|
400 |
Error 400 |
No Content |
2.3.4. Produces
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.3.5. Tags
-
Nitro Data
2.4. Stores a programme
PUT /programmes/{programmeid}
2.4.1. Description
Stores a programme
2.4.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
programmeid |
Identifier of the programme |
true |
string |
|
BodyParameter |
body |
false |
2.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
2.4.4. Consumes
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.4.5. Produces
-
application/json
-
application/x-yaml
-
application/xml
-
text/xml
2.4.6. Tags
-
Nitro Data
2.5. Deletes a programme
DELETE /programmes/{programmeid}
2.5.1. Description
Deletes a programme
2.5.2. Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
programmeid |
Identifier of the programme |
true |
string |
2.5.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
No Content |
2.5.4. Tags
-
Nitro Data
3. Definitions
3.1. programme
Name | Description | Required | Schema | Default |
---|---|---|---|---|
index |
true |
string |
||
type |
false |
string |
||
name |
false |
string |
||
pid |
false |
string |
||
available |
false |
string |
||
episode |
false |
string |
||
seriesnum |
false |
string |
||
episodenum |
false |
string |
||
versions |
false |
string |
||
duration |
false |
string |
||
desc |
false |
string |
||
channel |
false |
string |
||
categories |
false |
string |
||
thumbnail |
false |
string |
||
timeadded |
false |
string |
||
guidance |
false |
string |
||
web |
false |
string |