The PEG Systems API is a fully RESTful API. To learn more about REST click here

The API requires an authorization header of “Authorization” along with the base64 encoded key and passkey from your login. To see an example, please review the example API usage documentation.

The API can be accessed at:  http://admin.pegsystems.com/api/

 

 

Categories:

/Category
    /<limit> – Not required – The number of categories to return. Value of “N” means all
        /<hidden> – Not Required –  Return only hidden or not hidden categories “Y” or “N”

Returns:	an array of categoryObjects
Example:	https://admin.pegsystems.com/api/Category/N/Y would return all categories that are marked as Hidden

 

Series: 

/Series
    /listSeries
        /<limit> – Not Required –  The number of series to return. Value of “N” means all
            /<category> – Not Required –  The category of the series. Value of “N” or 0 means all categories
                /<hidden> – Not Required –  Return only hidden or not hidden categories “Y” or “N”, “0” means all
                    /<rangestart> – Not Required –  the start range. Useful for paging

Returns:	an array of seriesObjects
Example:	https://admin.pegsystems.com/api/Series/N/N/Y would return all series that are in categories marked as Hidden https://admin.pegsystems.com/api/Series/10/5 would return 10 series objects that are in category 5 https://admin.pegsystems.com/api/Series/5/6/0/10 would return 5 series objects in category 6 starting at object 10.

                  
    /<id> – Required –

Returns:	a specific seriesObject based on id number.
Example:	https://admin.pegsystems.com/api/Series/22 returns series object with id of 22.

 

Episodes:

/Episode
    /addHit
        /<id> – Required – this is the episode id to add a hit to
            /<ip> – Required – this is the ip address of the sender. This is used to prevent abuse of hit counting

Returns:	nothing
Example:	https://admin.pegsystems.com/api/Episode/addHit/55/192.168.1.1 Adds +1 to the hit count for episode id 55 with the ip of 192.168.1.

    /totals
        /<limit> – Not required – The number of producers to return. Value of “N” means all
            /<category> – Not Required –  The category of the series. Value of “N” or 0 means all categories
                /<series> – Not Required –  The specific series id. Value of “N” or 0 means all categories
                    /<exclude> – Exclude a specific type of episode. Valid values are: “series” or “special”, “N” means don’t exclude.
                        /<hidden> – Not Required –  Return only hidden or not hidden categories “Y” or “N”, “0” means all
                            /<featured> – Not Required – Return only featured episodes. Defaults to “0”, valid values are “Y” or “N”
                                /<rangestart> – Not Required –  the start range. Useful for paging

Returns:	The total count of episodes that meet the criteria above
Examples:	https://admin.pegsystems.com/api/Episode/totals/N/5/0/series/N/ Returns the count of episode that are “specials” in category 5, that are not Hidden https://admin.pegsystems.com/api/Episode/totals/N/0/6/N/Y/ Returns the count of all hidden episodes from series 6

    /itemsList
        /<limit> – Not required – The number of producers to return. Value of “N” means all
            /<category> – Not Required –  The category of the series. Value of “N” or 0 means all categories
                /<series> – Not Required –  The specific series id. Value of “N” or 0 means all categories
                    /<exclude> – Exclude a specific type of episode. Valid values are: “series” or “special”, “N” means don’t exclude.
                        /<hidden> – Not Required –  Return only hidden or not hidden categories “Y” or “N”, “0” means all
                            /<featured> – Not Required – Return only featured episodes. Defaults to “0”, valid values are “Y” or “N”
                                /<rangestart> – Not Required –  the start range. Useful for paging
                                    /<ordered by> – The ordering of the data. Default is by episode post date. Valid values are “airdate”,”ltdhits”,”mtdhits”,”recent”
                                        /<full listings> – Values are “Y” or “N”, default is “N”. Enabling this will return more detail such as Overlay values, Playlists, Producers, Hosts, Related Episodes, Seek Points. Rarely required to do a full listing

Returns:	an array of episode objects that meet the criteria above
Examples:	https://admin.pegsystems.com/api/Episode/totals/N/5/0/series/N/ Returns all episode objects that are “specials” in category 5, that are not Hidden https://admin.pegsystems.com/api/Episode/totals/N/0/6/N/Y/ Returns all episode objects that are hidden episodes from series 6

                                        
    /<id> – Required

Returns:	a specific episodeObject based on id number.
Example:	https://admin.pegsystems.com/api/Episode/22 returns episode object with id of 22.

Producers:

/Producer
    /listProducers
        /<limit> – Not required – The number of producers to return. Value of “N” means all
            /<type> – Not required – The type of producer. Valid options are: “individuals”,”entities” or “N” for all.
                /<rangestart> – Not required – the start range. Useful for paging

Returns:	an array of producerObjects
Example:	https://admin.pegsystems.com/api/listProducers/N/entities would return all producer objects that are entities https://admin.pegsystems.com/api/Producers/20/N/10 would return 20 producer objects starting at object 10

                
    /<id> –  Required

Returns:	a specific producerObject based on id number.
Example:	https://admin.pegsystems.com/api/Producer/22 returns producer object with id of 22.

 

News: 

/News
    /listNews
        /<limit>    – Not Required – The number of news items to return. Value of “N” means all
            /<type> – Not Required – Which type of news to return. Options are “news” or “crawler”

Returns:	an array of newsObjects
Example:	https://admin.pegsystems.com/api/News/listNews/10/crawler would return 10 news objects in the crawler category https://admin.pegsystems.com/api/News/listNews/N/crawler would return all news objects in the crawler category

    /<id> – Required

Returns:	a specific newsObject based on id number.
Example:	https://admin.pegsystems.com/api/News/22 returns news object with id of 22.

Search:

/Search
    /<search word> – Required – The searching parameter

Returns:	a searchObject which contains an array of producers,series and episodes
Example:	https://admin.pegsystems.com/api/Search/nick Returns all items with the word “nick” in it

Pages:

/Page
    /<type> – Required – The type of page valid values are: “schedule”,”donation”

Returns:	a pageObject based on type
Example:	https://admin.pegsystems.com/api/Page/donation

Mailing Lists:

/MailingList
    – in development
/Comment
    – in developement