swagger_client.WebBooksApi

All URIs are relative to https://localhost/api/v5

Method	HTTP request	Description
create_web_book	POST /web-books/book	Create a book
delete_web_book	DELETE /web-books/book/{id}	Delete a book
get_web_book	GET /web-books/book/{id}	Get a book
get_web_book_content	GET /web-books/book/{id}/html	Book HTML
get_web_book_content_post	POST /web-books/book/{id}/html	Book HTML
list_web_books	GET /web-books/book	List books
modify_web_book	PUT /web-books/book/{id}	Modify a book

create_web_book

WebBooksBook create_web_book(body=body, details=details, accept=accept, pretty=pretty)

Create a book

Create a new web book from the specified data. Required permissions: - web-books.book.create

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.WebBooksApi(swagger_client.ApiClient(configuration))
body = swagger_client.WebBooksBook() # WebBooksBook |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Create a book
    api_response = api_instance.create_web_book(body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->create_web_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	WebBooksBook		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

WebBooksBook

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_web_book

WebBooksBook delete_web_book(id, details=details, accept=accept, pretty=pretty)

Delete a book

Delete a web book. Required permissions: - web-books.book.delete

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.WebBooksApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Delete a book
    api_response = api_instance.delete_web_book(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->delete_web_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

WebBooksBook

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_web_book

WebBooksBook get_web_book(id, details=details, accept=accept, pretty=pretty)

Get a book

Get detailed information about a web book. Required permissions: - web-books.book.one

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.WebBooksApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Get a book
    api_response = api_instance.get_web_book(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->get_web_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

WebBooksBook

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_web_book_content

str get_web_book_content(id, details=details, accept=accept, pretty=pretty)

Book HTML

Get the web book content as HTML.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WebBooksApi()
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Book HTML
    api_response = api_instance.get_web_book_content(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->get_web_book_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded, application/xml, application/json
Accept: text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_web_book_content_post

str get_web_book_content_post(id, details=details, accept=accept, pretty=pretty)

Book HTML

Get the web book content as HTML.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WebBooksApi()
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Book HTML
    api_response = api_instance.get_web_book_content_post(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->get_web_book_content_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded, application/xml, application/json
Accept: text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_web_books

list[WebBooksBook] list_web_books(details=details, accept=accept, pretty=pretty)

List books

Get a list of all the web books on the server. Required permissions: - web-books.book.list

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.WebBooksApi(swagger_client.ApiClient(configuration))
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # List books
    api_response = api_instance.list_web_books(details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->list_web_books: %s\n" % e)

Parameters

Name	Type	Description	Notes
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

list[WebBooksBook]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

modify_web_book

WebBooksBook modify_web_book(id, body=body, details=details, accept=accept, pretty=pretty)

Modify a book

Modify an existing book. Required permissions: - web-books.book.modify

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.WebBooksApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
body = swagger_client.WebBooksBook() # WebBooksBook |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Modify a book
    api_response = api_instance.modify_web_book(id, body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebBooksApi->modify_web_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	WebBooksBook		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

WebBooksBook

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

WebBooksApi.md

Latest commit

History

WebBooksApi.md

File metadata and controls

swagger_client.WebBooksApi

create_web_book

Example

Parameters

Return type

Authorization

HTTP request headers

delete_web_book

Example

Parameters

Return type

Authorization

HTTP request headers

get_web_book

Example

Parameters

Return type

Authorization

HTTP request headers

get_web_book_content

Example

Parameters

Return type

Authorization

HTTP request headers

get_web_book_content_post

Example

Parameters

Return type

Authorization

HTTP request headers

list_web_books

Example

Parameters

Return type

Authorization

HTTP request headers

modify_web_book

Example

Parameters

Return type

Authorization

HTTP request headers