English (United Kingdom) StoryEditor API
StoryEditor API - popis funkcija
This is an action list for StoryEditor API. StoryEditor API is a part of every StoryEditor installation.
First, you will need a security token which you can request from StoryEditor developer team.
After getting a security token you can perform API actions.
All variables should be send with POST protocol.
getPublications
Action description: Return All System Publications.
Input data:
Input data:
- action
getProjects
Action description: Return All Projects of Publication.
Input data:
Input data:
- action
- publicationID
- publishDate (optional)
getProjectPage
Action description: Return URLs of Page Files. Page Data will be exported only if page is in final (send2press) status.
Input data:
Input data:
- action
- projectID
- pageNumber
getUsergroups
Action description: Return All System Usergroups.
Input data:
Input data:
- action
getUsers
Action description: Return All System Users.
Input data:
Input data:
- action
setUser
Action description: Insert new User and return ID.
Input data:
Input data:
- action
- username
- groupID
- realname
- first_name
- last_name
- initials
- def_desk
- personnelID
- cmsID
- enabled (Y/N)
updateUserField
Action description: Update field data for user.
Input data:
Input data:
- action
- userID
- field (groupID, realname, first_name, last_name, initials, def_desk, email, personnelID, cmsID, enabled)
- new_value (for enabled field use - Y/N)
updateUserPass
Action description: Update password for user.
Input data:
Input data:
- action
- userID
getAuthors
Action description: Return All Authors.
Input data:
Input data:
- action
setAuthor
Action description: Insert new Author and return ID.
Input data:
Input data:
- action
- author_name
- author_occupation
- author_email
- author_alias
- author_info
- cmsID
updateAuthor
Action description: Update Author Data.
Input data:
Input data:
- action
- searchField (id/cmsID)
- authorID
- author_name
- author_occupation
- author_email
- author_alias
- author_info
- cmsID
deleteAuthor
Action description: Delete Author.
Input data:
Input data:
- action
- searchField (id/cmsID)
- authorID
getSections
Action description: Return All Sections of a Publication.
Input data:
Input data:
- action
- publicationID
getArticleStatuses
Action description: Return All Statuses of a Publication.
Input data:
Input data:
- action
- publicationID
getArticleGrades
Action description: Return All Article Grades of a Publication.
Input data:
Input data:
- action
- publicationID
getEmbeds
Action description: Return All Embeds.
Input data:
Input data:
- action
getFlags
Action description: Return All Flags of a Publication.
Input data:
Input data:
- action
- publicationID
getArticleClass
Action description: Return All Article Class of a Publication.
Input data:
Input data:
- action
- publicationID
setArticleClass
Action description: Insert new Article Class.
Input data:
Input data:
- action
- publicationID
- article_class_type
updateArticleClass
Action description: Update Article Class Data.
Input data:
Input data:
- action
- classID
- article_class_type (optional)
- check_class (optional Y/N)
- media_no (optional cInt)
- has_feature_media (optional Y/N)
- media_has_credit (optional Y/N)
- media_has_caption (optional Y/N)
- tag_no (optional cInt)
- flag_no (optional cInt)
- check_web_overhead (optional Y/N)
- check_web_head (optional Y/N)
- check_web_subhead (optional Y/N)
- check_web_intro (optional Y/N)
- check_web_text (optional Y/N)
- check_web_text_limit (optional Y/N)
- web_text_limit (optional cInt)
- price (optional decimal 7,2)
- class_color (optional)
- cmsClass (optional)
getInfoboxType
Action description: Return All Infobox Types of a Publication.
Input data:
Input data:
- action
- publicationID
setInfoboxType
Action description: Insert new Article Infobox Type.
Input data:
Input data:
- action
- publicationID
- IBtype
updateInfoboxType
Action description: Update Article Infobox Type.
Input data:
Input data:
- action
- IBtypeID
- IBtype (optional)
getMediaSources
Action description: Return All Media Sources.
Input data:
Input data:
- action
setArticle
Action description: Insert new Article and return ID.
Input data:
Input data:
- action
- title
- section
- user_created (optional; integer)
getArticle
Action description: Get Article data.
Input data:
Input data:
- action
- articleID
getArticlesByTitleAndSection
Action description: Return Article IDs.
Input data:
Input data:
- action
- title
- sectionID
getArticlesBySearch
Action description: Return Article IDs.
Input data:
Input data:
- action
- search
getProjectArticles
Action description: Return Article IDs of Articles connected with Project.
Input data:
Input data:
- action
- projectID
getAllArticles
Action description: Return All Article IDs.
Input data:
Input data:
- action
- publicationID (optional)
- YearOfCreation (optional)
- YearOfPublish (optional)
- PublishDate (optional - yyyy-mm-dd)
- sectionID (optional)
- pageNumber (optional)
- template_position (optional)
updateArticle
Action description: Update Article data.
Input data:
Input data:
- action
- articleID
- output_channel (print/web)
- status_id (optional)
- title (optional)
- sectionID (optional)
- city (optional)
- overhead (optional)
- head (optional)
- subhead (optional)
- text (optional)
- intro_text (optional)
- teaser (optional)
- author (optional)
- author_confirmation (optional Y/N)
- c_date (optional)
- last_modified_by_userid (optional)
- modification_datetime (optional)
- p_date (optional)
- publish_from (optional)
- publish_to (optional)
- article_class_id
- dtp_message (optional)
- cmsID (optional)
- cmsURL (optional)
- cmsURL_OLD (optional)
- article_deleted (optional Y/N)
- auto_publish2web (optional Y/N)
getArticleInfoboxes
Action description: Get the list of Article Infoboxes.
Input data:
Input data:
- action
- articleID
- title (optional)
- template_position (optional)
setArticleInfobox
Action description: Insert new Infobox and return ID.
Input data:
Input data:
- action
- articleID
updateArticleInfobox
Action description: Update Infobox data.
Input data:
Input data:
- action
- infoboxID
- output_channel (print/web)
- heading (optional)
- text (optional)
- IBtypeID (optional)
- infobox_order (optional)
- use_for_web (optional Y/N)
- comment (optional)
deleteArticleInfobox
Action description: Delete Article Infobox.
Input data:
Input data:
- action
- infoboxID
setMedia
Action description: Upload new Media item and return ID.
Input data:
Input data:
- action
- mediaURL
updateMedia
Action description: Update Media data.
Input data:
Input data:
- action
- mediaID
- blocked (optional Y/N)
- author (optional)
- caption (optional)
- city (optional)
- copyright_notice (optional)
- country (optional)
- credit (optional)
- infodate (optional)
- headline (optional)
- keywords (optional)
- object_name (optional)
- special_instructions (optional)
- sourceID (optional)
getMediaByMediaID
Action description: Get Media Item data by SE id value.
Input data:
Input data:
- action
- mediaID
getMediaByImportedID
Action description: Get Media Item data by imported id value.
Input data:
Input data:
- action
- importedID
getArticleMedia
Action description: get the List of All media Connected with Article.
Input data:
Input data:
- action
- articleID
setArticleMedia
Action description: Connect Media item with Article and return articleMediaID.
Input data:
Input data:
- action
- articleID
- mediaID
updateArticleMedia
Action description: Update Article Media data.
Input data:
Input data:
- action
- articleMediaID
- output_channel (print/web)
- caption (optional)
- credit (optional)
- title (optional)
- media_order (optional)
- use_for_web (optional Y/N)
- focusX (optional)
- focusY (optional)
- percentageX (optional)
- percentageY (optional)
deleteArticleMedia
Action description: Disconnect Article Media Item with Article.
Input data:
Input data:
- action
- articleMediaID
getArticleContributors
Action description: Return List of All Article Contributors.
Input data:
Input data:
- action
- articleID
setArticleContributor
Action description: Insert Article Contributor.
Input data:
Input data:
- action
- articleID
- userID (optional)
- contributor_name (optional)
- contributor_function (optional - author, photo, editor, graphic, proofreader or designer)
- gradeID (optional)
- percent (optional)
- list_order (optional)
deleteArticleContributor
Action description: Delete Contributor from Article.
Input data:
Input data:
- action
- articleID
- id
getArticleFlags
Action description: Return List of All Article Flags.
Input data:
Input data:
- action
- articleID
setArticleFlag
Action description: Insert Article Flag.
Input data:
Input data:
- action
- articleID
- flagID
- flag_optID
- flag_value
- flag_name
deleteArticleFlag
Action description: Delete Flag from Article.
Input data:
Input data:
- action
- articleID
- id
getArticleWebTags
Action description: Get the list of All Article Web Tags.
Input data:
Input data:
- action
- articleID
setArticleWebTags
Action description: Update Web Tags of an Article.
Input data:
Input data:
- action
- articleID
- webtags (comma separated string like "tag1, tag2, tag3")
getRelatedArticles
Action description: Get the list of All Related Articles.
Input data:
Input data:
- action
- articleID
send2web
Action description: Send Article 2 Web.
Input data:
Input data:
- action
- articleID
getObituaryStatuses
Action description: Get all obituary statuses.
Input data:
Input data:
- action
getObituaryLocations
Action description: Get all obituary locations.
Input data:
Input data:
- action
getObituaryCategories
Action description: Get all obituary categories.
Input data:
Input data:
- action
- publicationID
getObituaryFormats
Action description: Get all obituary formats.
Input data:
Input data:
- action
- publicationID
getObituaryGroups
Action description: Get all obituary groups.
Input data:
Input data:
- action
- publicationID
getObituaries
Action description: Get obituaries.
Input data:
Input data:
- action
- publishDate
- obituaryID (optional)
- categoryID (optional)
- formatID (optional)
- special_code (optional)
- crmID (optional)
getObituaryPersons
Action description: Get all persons of one obituary.
Input data:
Input data:
- action
- obituaryID
setObituary
Action description: Create or update obituary. If obituaryID is provided than the action is doing update.
Input data:
Input data:
- action
- obituaryID (optional)
- all obitary fields, listed from getObituaries (optional)
setObituaryPerson
Action description: Create or update obituary person. If personID is provided than the action is doing update.
Input data:
Input data:
- action
- personID (optional)
- all obitary person fields, listed from getObituaryPersons (optional)