Phoenix Syndicate

Next-generation digital publishing

Article

Articles are content and generally a news story

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the Article[queryable][sortable]
TitleSystem.String the headline this Article[queryable][required]
DescriptionSystem.String a concise summary describing the story[queryable]
AuthorSystem.Stringthe writer or publisher of the Article
ImageUrlSystem.Stringan optional thumbnail image to the Article
ContentDataSystem.String the story of the Article which may contain HTML characters[queryable][required]
LinkSystem.StringA link to the online article
PublishDateSystem.DateTime UTC date for the Article to appear to consumers[queryable][sortable][required]
MetaDataParametersList<KeyValuePair<string, string>>optional name value pairs to extend the definition of an Article
ReferenceSystem.String an optional Reference that third parties can use to retrieve this article[queryable]
IsActiveSystem.Boolean whether this Article should be publicly visible or not[queryable][sortable][required]
ViewCount_OverallSystem.Int32  The number of views this Article has had overall.[queryable][sortable][required]
VoteCount_OverallSystem.Int32  The number of votes this Article has had overall.[queryable][sortable][required]
Rating_OverallSystem.Double  The average rating of this Article overall.[queryable][sortable][required]
CommentCount_OverallSystem.Int32  The number of comments this Article has had overall.[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Article belongs to[queryable][sortable][required]
AssetsICollection[]Navigation property to Asset [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateArticle
Create a new ArticleSoapRestC#
GetArticle
Get a specific Article by its IdSoapRestC#
ListArticle
Returns a paged list of Articles optionally filtered and sortedSoapRestC#
UpdateArticle
Update an existing ArticleSoapRestC#

ArticleCollectionMap

A mapping between Sections and Articles and Editions

Properties

Name Type Description
IdSystem.Int32 the primary Identifier for the ArticleCollectionMap[queryable][sortable]
EditionIdSystem.Int32 the optional Edition that this collection of Articles relates to[queryable]
SectionIdSystem.Int32 the optional Section that this collection of Articles relates to[queryable]
ArticleIdSystem.Int32 the Article involved in the mapping[queryable][sortable][required]
RankSystem.Int32 the sort order of the Article in the collection[sortable]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last modified[queryable][sortable]
CollectionIdSystem.Int32 the CollectionId this Object belongs to[queryable][required]
ArticleArticleNavigation property to Article [expandable]
CollectionCollectionNavigation property to Collection [expandable]
EditionEditionNavigation property to Edition [expandable]
SectionSectionNavigation property to Section [expandable]

Operations

CreateArticleCollectionMap
Create a new ArticleCollectionMapSoapRestC#
GetArticleCollectionMap
Get a specific ArticleCollectionMap by its IdSoapRestC#
ListArticleCollectionMap
Returns a paged list of ArticleCollectionMaps optionally filtered and sortedSoapRestC#
UpdateArticleCollectionMap
Update an existing ArticleCollectionMapSoapRestC#

ArticleInteraction

Each User can perform an Interaction on an Article which reflects that latest status.

Properties

Name Type Description
ArticleIdSystem.Int32 the Article that this Interaction relates to[queryable][sortable][required]
PhoenixIdentity_UserIdSystem.Int32 the User from PhoenixIdentity that performed this interaction[queryable][sortable]
InteractionTypeIdInteractionTypeEnum the type of Interaction that was performed[queryable][sortable]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[sortable]
ArticleArticleNavigation property to Article [expandable]

Operations

ApplyArticleInteraction
Create a new ArticleInteractionSoapRestC#
GetArticleInteraction
Get a specific ArticleInteraction by its IdSoapRestC#
ListArticleInteraction
Returns a paged list of ArticleInteractions optionally filtered and sortedSoapRestC#

Asset

Assets are binary files and belong to Articles

Properties

Name Type Description
IdSystem.Int32 the primary identifier for this Asset[queryable][sortable]
AssetTypeIdAssetTypeEnum the type of Asset this is (Image, Video, Pdf etc)[queryable][sortable]
ArticleIdSystem.Int32 the Article that the Asset belongs to[queryable][sortable][required]
NameSystem.Stringthe Name of this Asset
CaptionSystem.Stringa short Caption for the Asset
AuthorSystem.Stringthe Author that created this Asset
CopyrightSystem.Stringthe Copyright information for this Asset
UrlSystem.Stringthe location of the Asset
ThumbnailUrlSystem.Stringan optional preview image for the Asset [required]
RankSystem.Int32 the sort order of the Asset within the Article[queryable][sortable]
PublishDateSystem.DateTime the date that this Asset should be available publicly[queryable][sortable]
DurationSystem.Int32 in the case of Videos, the length (in seconds)[queryable][sortable]
FileSizeSystem.Int32 the size of the Asset on disk[queryable][sortable]
ReferenceSystem.Stringan optional Reference that third parties can use to retrieve the Asset by
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
MetaDataParametersList<KeyValuePair<string, string>>Optional data to extend the definition of an Asset

Operations

CreateAsset
Create a new AssetSoapRestC#
GetAsset
Get a specific Asset by its IdSoapRestC#
ListAsset
Returns a paged list of Assets optionally filtered and sortedSoapRestC#
UpdateAsset
Update an existing AssetSoapRestC#

Collection

Properties

Name Type Description
IdSystem.Int32the primary identifier for this Collection
NameSystem.StringThe publicly viewable Name of the Collection[required]
ProjectIdSystem.Int32The Project that this collection raltes to[required]
HasEditionSystem.BooleanSpecifies whether the elements of this Collection should relate to an Edition[required]
HasSectionSystem.BooleanSpecifies whether the elements of this Collection should relate to a Section[required]
HasRankSystem.BooleanSpecifies whether the elements of this Collection should be ordered by the Rank property, or by the Article element's PublishDate property.[required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last modified[queryable][sortable]
ReferenceSystem.String An optional Reference for third parties to retrieve the Collection by [queryable][required]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateCollection
Create a new CollectionSoapRestC#
GetCollection
Get a specific Collection by its IdSoapRestC#
ListCollection
Returns a paged list of Collections optionally filtered and sortedSoapRestC#
UpdateCollection
Update an existing CollectionSoapRestC#

DeleteResponse

Properties

Name Type Description

Operations

DeleteArticle
Delete an existing ArticleSoapRestC#
DeleteArticleCollectionMap
Delete an existing ArticleCollectionMapSoapRestC#
DeleteArticleInteraction
Delete an existing ArticleInteractionSoapRestC#
DeleteAsset
Delete an existing AssetSoapRestC#
DeleteCollection
Delete an existing CollectionSoapRestC#
DeleteEdition
Delete an existing EditionSoapRestC#
DeleteFeed
Delete an existing FeedSoapRestC#
DeleteSection
Delete an existing SectionSoapRestC#

Edition

Editions are collections of Articles that are released periodically. They are akin to magazines or newspapers.

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the Edition[queryable][sortable]
ProjectIdSystem.Int32the Project that this Edition belongs to[required]
StatusTypeIdStatusTypeEnumthe Status of this Edition
TitleSystem.String the public Title of this Edition[queryable][sortable]
DescriptionSystem.Stringa longer Description of the Edition
CoverImageUrlSystem.Stringan optional cover for the edition
MajorVersionSystem.Int32the required version that the consumer needs to be in order to view this edition
MinorVersionSystem.Int32the required version that the consumer needs to be in order to view this edition
PointVersionSystem.Int32the required version that the consumer needs to be in order to view this edition
LiveDateSystem.DateTimeUTC date that the Edition should appear to the consumer
ReferenceSystem.String used by an external system to identify the Edition[queryable][required]
IsActiveSystem.Boolean Whether this Edition should be publicly viewable[queryable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
MetaDataParametersList<KeyValuePair<string, string>>Optional data to extend the definition of an Edition
ProjectProjectNavigation property to Project [expandable]

Operations

CreateEdition
Create a new EditionSoapRestC#
GetEdition
Get a specific Edition by its IdSoapRestC#
ListEdition
Returns a paged list of Editions optionally filtered and sortedSoapRestC#
UpdateEdition
Update an existing EditionSoapRestC#

Feed

Feeds are external sources of data that the Syndicate Importer connects to and ingests

Properties

Name Type Description
IdSystem.Int32 the primary Identifier for this Feed[queryable][sortable]
SectionIdSystem.Int32 the Section that the Articles in this Feed get created into[queryable][sortable][required]
FeedTypeIdFeedTypeEnum how this Feed should be treated - creating Articles or Asset Galleries[queryable][sortable]
IsActiveSystem.Boolean whether this Feed should be processed by the Syndicate Processor or not[queryable][sortable][required]
TitleSystem.String the Title of this Feed[queryable][sortable]
UrlSystem.Stringthe URL from where this RSS or Atom feed is located[required]
NextUpdateSystem.DateTime the UTC date of the next time to fetch articles from this Feed[queryable][sortable]
TTLSystem.Int32 how long to sleep in between fetches from the Feed.Url[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
SectionSectionNavigation property to Section [expandable]

Operations

CreateFeed
Create a new FeedSoapRestC#
DequeuePendingFeed
Returns a paged list of Feeds ready to be processed optionally filtered and sortedSoapRestC#
GetFeed
Get a specific Feed by its IdSoapRestC#
ListFeed
Returns a paged list of Feeds optionally filtered and sortedSoapRestC#
UpdateFeed
Update an existing FeedSoapRestC#

FeedLog

The FeedLog stores a history of all feed imports, including those that failed

Properties

Name Type Description
IdSystem.Int32 the primary Identifier for the FeedLog[queryable][sortable]
FeedIdSystem.Int32the Feed that this FeedLog relates to[required]
StatusTypeIdStatusTypeEnumwhether the import succeeded or failed
DescriptionSystem.Stringa brief description of the error (if any) that was encountered[required]
StackTraceSystem.Stringthe stack trace of any error that was encountered[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
FeedFeedNavigation property to Feed [expandable]

Operations

CreateFeedLog
Create a new entry in the FeedLogSoapRestC#

ImporterPlugin

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the ImporterPlugin[queryable][sortable]
AssemblyNameSystem.StringThe Name of the Plugin Assembly[required]
TypeNameSystem.StringThe Name of the Plugin Type[required]
AssemblyBytesSystem.ByteRaw bytes of the Plugin Assembly[required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
ProjectIdSystem.Int32the Project that this Plugin belongs to[required]
ProjectProjectNavigation property to Project [expandable]

Operations

ListImporterPlugin
Returns a paged list of ImporterPlugins optionally filtered and sortedSoapRestC#

Project

Refers to the core PhoenixIdentity.Project table

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 the central Project in the PhoenixIdentity module[queryable][sortable][required]
HasEditionsSystem.Booleanwhether this Project contains Editions[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
EditionPackageTypeIdNullableType of edition package type
EditionBroadcastTemplateGroupIdSystem.Int32The broadcast template this project belongs too
EditionBroadcastGroupIdSystem.Int32The broadcast group the edition belongs too
MetaDataParametersList<KeyValuePair<string, string>>Optional data to extend the definition of a Syndicate Project
ImporterPluginIdSystem.Int32the ImporterPlugin related to this Project
ImporterPluginImporterPluginNavigation property to ImporterPlugin [expandable]

Operations

ActivateModule
Description not availableSoapRestC#
DeactivateModule
Description not availableSoapRestC#
GetModuleSettings
Description not availableSoapRestC#
UpdateModuleSettings
Description not availableSoapRestC#

Section

A Section is a logical grouping of Articles

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the Section[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Section belongs to[queryable][sortable][required]
ParentSectionIdSystem.Int32 Sections can be contained within other Sections[queryable][sortable]
PhoenixIdentity_GroupId_OwnerSystem.Int32 a group of users (in Phoenix Identity) that may Create and Update Articles within the Section[queryable][sortable]
PhoenixIdentity_GroupId_SubscriberSystem.Int32 a group of users (in Phoenix Identity) that may view the Articles contained within this Section[queryable][sortable]
TitleSystem.Stringthe publicly viewable Title of the Section
DescriptionSystem.Stringa concise summary of the Section
IsActiveSystem.Boolean whether the Section is publicy available[queryable][sortable][required]
RankSystem.Int32 the sort order of the Section[queryable][sortable][required]
ImageUrlSystem.Stringan optional thumbnail image for the Section
ReferenceSystem.String an optional Reference for third parties to retrieve the Section by [queryable]
MajorVersionSystem.Int32 the required version that the consumer needs to be in order to view this Section[queryable][sortable]
MinorVersionSystem.Int32 the required version that the consumer needs to be in order to view this Section[queryable][sortable]
PointVersionSystem.Int32 the required version that the consumer needs to be in order to view this Section[queryable][sortable]
MetaDataParametersList<KeyValuePair<string, string>>optional name value pairs to extend the definition of a Section
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]

Operations

CreateSection
Create a new SectionSoapRestC#
GetSection
Get a specific Section by its IdSoapRestC#
ListSection
Returns a paged list of Sections optionally filtered and sortedSoapRestC#
UpdateSection
Update an existing SectionSoapRestC#

UploadArticlePreviewResponse

Properties

Name Type Description

Operations

UploadArticlePreview
Upload a preview image and attach it to the article itemSoapRestC#

UploadAssetResponse

Properties

Name Type Description

Operations

UploadAsset
Upload a transcoded asset file (picture) and attach it to the asset itemSoapRestC#

UploadImporterPluginResponse

Properties

Name Type Description

Operations

UploadImporterPlugin
Uploads a ImporterPlugin for a ProjectSoapRestC#