API

class zopyx.smashdocs.api.Smashdocs(partner_url, client_id, client_key, group_id=None)
api_min_version

Minmal API version

api_min_version_tp

Minmal API version as integer tuple

archive_document(document_id)

Archive document by document_id

Parameters:document_id – Smashdocs document id
Return type:None
delete_document(document_id)

Delete document by document_id

Parameters:document_id – Smashdocs document id
Return type:None
document_info(document_id, userId=None)

Get document information

Parameters:document_id – Smashdocs document id
duplicate_document(document_id, title=None, description=None, creator_id=None)

Duplicate document

Parameters:
  • documen_id – Smashdocs document id to be duplicated
  • title – title of new document
  • description – description of new document
  • creator_id – Creator id
export_document(document_id, user_id, template_id=None, format='docx', settings={}, output_filename=None, mode='final')

Export document

Parameters:
  • documen_id – Smashdocs document id to be exported
  • user_id – user id of the Smashdocs user performing the export
  • template_id – template UID of a word template (mandatory if format=’docx’)
  • format – docx|html|sdxml|parsx
  • settings – DOCX specific export settings (https://documentation.smashdocs.net/api_guide.html#exporting-documents-to-word)
  • mode – final|news|allInOne|redlineAndPending
get_documents(group_id=None, user_id=None)

Get all document

list_unseen_changes(user_id=None)

List documents with unseen changes

Parameters:user_id – user id of the Smashdocs user performing the export
new_document(title=None, description=None, role=None, user_data=None, status='draft')

Create a new document

Parameters:
  • title – title of document
  • description – description of document
  • role – Smashdocs role: editor|reader|approver|commentator
  • user_data – Smashdocs user data, see Smashdocs Partner API
  • status – create new document in draft|review mode
open_document(document_id, role=None, user_data={})

Open document

Parameters:
  • document_id – Document id
  • role – Smashdoc role: editor|reader|approver|commentator
  • user_data – Dict with user data, see Smashdocs Partner API
review_document(document_id)

Set document by document_id into review state

Parameters:document_id – Smashdocs document id
Return type:None
unarchive_document(document_id)

Unarchive document by document_id

Parameters:document_id – Smashdocs document id
Return type:None
unseen_count(user_id=None)

Get unseen count changes across all documents.

Parameters:user_id – user id of the Smashdocs user performing the export
update_metadata(document_id, **kw)

Update metadata

upload_document(filename, title=None, description=None, role=None, user_data=None, status='draft')

Upload DOCX document

Parameters:
  • filename – DOCX filename
  • title – title of document
  • description – description of document
  • role – Smashdoch role: editor|reader|approver|commentator
  • user_data – dict with user data
  • status – create new document in draft|review mode
Return type:

Smashdocs return datastructure (see Partner API docs for details)

validate_sdxml(xml)

Validate given XML SDXML string against SDXML XSD