Skip to main content

Podlove Publisher API (2)

analytics

Get download numbers per episode for all episodes.

Get download numbers per episode for all episodes.

query Parameters
format
string

Responses

Response samples

Content type
[]

Get download numbers for an episode.

Get download numbers for an episode.

path Parameters
id
required
integer <int64>
query Parameters
format
string

Responses

Response samples

Content type
{}

podcast

Get the information about the podcast

Get the information about the podcast

Responses

Response samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
  • "funding_url": "",
  • "funding_label": "",
  • "copyright": "© 2022 Podlovers",
  • "expicit": false,
  • "category": "Technology"
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string

Title of the podcast

subtitle
string

Extension to the title. Clarify what the podcast is about.

summary
string

Elaborate description of the podcasts content.

mnemonic
string

Abbreviation for your podcast.

itunes_type
string
Enum: "episodic" "serial"
author_name
string

Name of the podcast author. Publicly displayed in Podcast directories.

podcast_email
string

Used by iTunes and other Podcast directories to contact you.

poster
string or null
link
string
funding_url
string

Can be used by podcatchers show funding/donation links for the podcast.

funding_label
string

Label for funding/donation URL.

copyright
string

Copyright notice for content in the channel.

explicit
boolean

Is the overall content of the podcast explicit?

category
string
Enum: "Arts" "Design" "Fashion & Beauty" "Food" "Books" "Performing Arts" "Visual Arts" "Business" "Careers" "Investing" "Management" "Entrepreneurship" "Marketing" "Non-Profit" "Comedy" "Comedy Interviews" "Improv" "Stand-Up" "Education" "Language Learning" "Courses" "How To" "Self-Improvement" "Fiction" "Comedy Fiction" "Drama" "Science Fiction" "Government" "History" "Health & Fitness" "Alternative Health" "Fitness" "Sexuality" "Medicine" "Mental Health" "Nutrition" "Kids & Family" "Education for Kids" "Parenting" "Pets & Animals" "Stories for Kids" "Leisure" "Animation & Manga" "Automotive" "Aviation" "Crafts" "Games" "Hobbies" "Home & Garden" "Video Games" "Music" "Music Commentary" "Music History" "Music Interviews" "News" "Business News" "Daily News" "Entertainment News" "News Commentary" "Politics" "Sports News" "Tech News" "Religion & Spirituality" "Buddhism" "Christianity" "Hinduism" "Islam" "Judaism" "Religion" "Spirituality" "Science" "Natural Sciences" "Social Sciences" "Astronomy" "Chemistry" "Earth Sciences" "Life Sciences" "Mathematics" "Nature" "Physics" "Society & Culture" "Personal Journals" "Philosophy" "Places & Travel" "Relationships" "Documentary" "Sports" "Baseball" "Basketball" "Cricket" "Fantasy Sports" "Football" "Golf" "Hockey" "Rugby" "Running" "Soccer" "Swimming" "Tennis" "Volleyball" "Wilderness" "Wrestling" "Technology" "True Crime" "TV & Film" "After Shows" "Film History" "Film Interviews" "Film Reviews" "TV Reviews"

iTunes category of the podcast

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
  • "funding_url": "",
  • "funding_label": "",
  • "copyright": "© 2022 Podlovers",
  • "expicit": false,
  • "category": "Technology"
}

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "sorry, you do not have permissions to use this REST API endpoint"
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string

Title of the podcast

subtitle
string

Extension to the title. Clarify what the podcast is about.

summary
string

Elaborate description of the podcasts content.

mnemonic
string

Abbreviation for your podcast.

itunes_type
string
Enum: "episodic" "serial"
author_name
string

Name of the podcast author. Publicly displayed in Podcast directories.

podcast_email
string

Used by iTunes and other Podcast directories to contact you.

poster
string or null
link
string
funding_url
string

Can be used by podcatchers show funding/donation links for the podcast.

funding_label
string

Label for funding/donation URL.

copyright
string

Copyright notice for content in the channel.

explicit
boolean

Is the overall content of the podcast explicit?

category
string
Enum: "Arts" "Design" "Fashion & Beauty" "Food" "Books" "Performing Arts" "Visual Arts" "Business" "Careers" "Investing" "Management" "Entrepreneurship" "Marketing" "Non-Profit" "Comedy" "Comedy Interviews" "Improv" "Stand-Up" "Education" "Language Learning" "Courses" "How To" "Self-Improvement" "Fiction" "Comedy Fiction" "Drama" "Science Fiction" "Government" "History" "Health & Fitness" "Alternative Health" "Fitness" "Sexuality" "Medicine" "Mental Health" "Nutrition" "Kids & Family" "Education for Kids" "Parenting" "Pets & Animals" "Stories for Kids" "Leisure" "Animation & Manga" "Automotive" "Aviation" "Crafts" "Games" "Hobbies" "Home & Garden" "Video Games" "Music" "Music Commentary" "Music History" "Music Interviews" "News" "Business News" "Daily News" "Entertainment News" "News Commentary" "Politics" "Sports News" "Tech News" "Religion & Spirituality" "Buddhism" "Christianity" "Hinduism" "Islam" "Judaism" "Religion" "Spirituality" "Science" "Natural Sciences" "Social Sciences" "Astronomy" "Chemistry" "Earth Sciences" "Life Sciences" "Mathematics" "Nature" "Physics" "Society & Culture" "Personal Journals" "Philosophy" "Places & Travel" "Relationships" "Documentary" "Sports" "Baseball" "Basketball" "Cricket" "Fantasy Sports" "Football" "Golf" "Hockey" "Rugby" "Running" "Soccer" "Swimming" "Tennis" "Volleyball" "Wilderness" "Wrestling" "Technology" "True Crime" "TV & Film" "After Shows" "Film History" "Film Interviews" "Film Reviews" "TV Reviews"

iTunes category of the podcast

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
  • "funding_url": "",
  • "funding_label": "",
  • "copyright": "© 2022 Podlovers",
  • "expicit": false,
  • "category": "Technology"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string

Title of the podcast

subtitle
string

Extension to the title. Clarify what the podcast is about.

summary
string

Elaborate description of the podcasts content.

mnemonic
string

Abbreviation for your podcast.

itunes_type
string
Enum: "episodic" "serial"
author_name
string

Name of the podcast author. Publicly displayed in Podcast directories.

podcast_email
string

Used by iTunes and other Podcast directories to contact you.

poster
string or null
link
string
funding_url
string

Can be used by podcatchers show funding/donation links for the podcast.

funding_label
string

Label for funding/donation URL.

copyright
string

Copyright notice for content in the channel.

explicit
boolean

Is the overall content of the podcast explicit?

category
string
Enum: "Arts" "Design" "Fashion & Beauty" "Food" "Books" "Performing Arts" "Visual Arts" "Business" "Careers" "Investing" "Management" "Entrepreneurship" "Marketing" "Non-Profit" "Comedy" "Comedy Interviews" "Improv" "Stand-Up" "Education" "Language Learning" "Courses" "How To" "Self-Improvement" "Fiction" "Comedy Fiction" "Drama" "Science Fiction" "Government" "History" "Health & Fitness" "Alternative Health" "Fitness" "Sexuality" "Medicine" "Mental Health" "Nutrition" "Kids & Family" "Education for Kids" "Parenting" "Pets & Animals" "Stories for Kids" "Leisure" "Animation & Manga" "Automotive" "Aviation" "Crafts" "Games" "Hobbies" "Home & Garden" "Video Games" "Music" "Music Commentary" "Music History" "Music Interviews" "News" "Business News" "Daily News" "Entertainment News" "News Commentary" "Politics" "Sports News" "Tech News" "Religion & Spirituality" "Buddhism" "Christianity" "Hinduism" "Islam" "Judaism" "Religion" "Spirituality" "Science" "Natural Sciences" "Social Sciences" "Astronomy" "Chemistry" "Earth Sciences" "Life Sciences" "Mathematics" "Nature" "Physics" "Society & Culture" "Personal Journals" "Philosophy" "Places & Travel" "Relationships" "Documentary" "Sports" "Baseball" "Basketball" "Cricket" "Fantasy Sports" "Football" "Golf" "Hockey" "Rugby" "Running" "Soccer" "Swimming" "Tennis" "Volleyball" "Wilderness" "Wrestling" "Technology" "True Crime" "TV & Film" "After Shows" "Film History" "Film Interviews" "Film Reviews" "TV Reviews"

iTunes category of the podcast

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
  • "funding_url": "",
  • "funding_label": "",
  • "copyright": "© 2022 Podlovers",
  • "expicit": false,
  • "category": "Technology"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes

A list of episodes

A list of episodes

query Parameters
status
string
Enum: "publish" "draft" "all"

The status parameter is used to filter the collection of episodes

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "results": [
    ]
}

Create a new episode

Create a new episode

Responses

Response samples

Content type
application/json
{
  • "message": "Episode successfully created with id 10",
  • "location": "null",
  • "id": 10
}

The information about an episode

The information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 10,
  • "post_id": 80,
  • "title": "Title of the episode",
  • "title_clean": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "slug": "PodloveTest000",
  • "duration": "00:02:03.453",
  • "type": "full",
  • "publicationDate": "2022-03-20T12:30:08.000Z",
  • "recording_date": "2022-02-20T12:30:08.000Z",
  • "poster": "",
  • "episode_poster": "",
  • "link": "",
  • "audio": [],
  • "files": [],
  • "number": 10,
  • "mnemonic": "LOV010",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explicit": false,
  • "license_name": "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License",
  • "season_id": 2
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string

Episode media file slug

type
string
Enum: "full" "trailer" "bonus"

Episode type. May be used by podcast clients.

episode_poster
string

An url for the episode cover. This value is only applied if the Episode Asset Image option is set to manual.

duration
string

Duration of the episode. Please, use NormalPlayTime format.

soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explicit
boolean

explicit content?

recording_date
string
license_name
string

Name of the license

license_url
string

URL to the license

Responses

Request samples

Content type
application/json
{
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "slug": "PodloveTest001",
  • "duration": "00:48:10",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explicit": false
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string

Episode media file slug

type
string
Enum: "full" "trailer" "bonus"

Episode type. May be used by podcast clients.

episode_poster
string

An url for the episode cover. This value is only applied if the Episode Asset Image option is set to manual.

duration
string

Duration of the episode. Please, use NormalPlayTime format.

soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explicit
boolean

explicit content?

recording_date
string
license_name
string

Name of the license

license_url
string

URL to the license

Responses

Request samples

Content type
application/json
{
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "slug": "PodloveTest001",
  • "duration": "00:48:10",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explicit": false
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string

Episode media file slug

type
string
Enum: "full" "trailer" "bonus"

Episode type. May be used by podcast clients.

episode_poster
string

An url for the episode cover. This value is only applied if the Episode Asset Image option is set to manual.

duration
string

Duration of the episode. Please, use NormalPlayTime format.

soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explicit
boolean

explicit content?

recording_date
string
license_name
string

Name of the license

license_url
string

URL to the license

Responses

Request samples

Content type
application/json
{
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "slug": "PodloveTest001",
  • "duration": "00:48:10",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explicit": false
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Move an episode to the wordpress trash

Move an episode to the wordpress trash

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes/media

The information about the assets of an episode

The information about the assets of an episode

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{}

Enable an asset of the episode

Enable an asset of the episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
asset_id
integer

Identifier for the asset of an episode

enable
boolean

Should the asset enable?

Responses

Request samples

Content type
application/json
{
  • "asset_id": 2,
  • "enable": true
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Enable an asset of the episode

Enable an asset of the episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
asset_id
integer

Identifier for the asset of an episode

enable
boolean

Should the asset enable?

Responses

Request samples

Content type
application/json
{
  • "asset_id": 2,
  • "enable": true
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Enable an asset of the episode

Enable an asset of the episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
asset_id
integer

Identifier for the asset of an episode

enable
boolean

Should the asset enable?

Responses

Request samples

Content type
application/json
{
  • "asset_id": 2,
  • "enable": true
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes/related

Get a list of related episode to the episode.

Get a list of related episode to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

query Parameters
status
string
Enum: "publish" "draft" "all"

The result should be included the episodes in the published and draft status. As a public user you get only published episodes and the status parameter has no impact

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "relatedEpisodes": [
    ]
}

Set a list of related episodes to the episode. The

Set a list of related episodes to the episode. The existing items will be deleted before the new values set.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
related
Array of integers or integer

Responses

Request samples

Content type
application/json
{
  • "related": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Set a list of related episodes to the episode. The

Set a list of related episodes to the episode. The existing items will be deleted before the new values set.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
related
Array of integers or integer

Responses

Request samples

Content type
application/json
{
  • "related": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Set a list of related episodes to the episode. The

Set a list of related episodes to the episode. The existing items will be deleted before the new values set.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
related
Array of integers or integer

Responses

Request samples

Content type
application/json
{
  • "related": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the related episode to the episode

Delete the related episode to the episode

path Parameters
id
required
string

Unique identifier for the episode

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Create an episode relation.

Create an episode relation.

Request Body schema: application/json
object
episode_id
string
related_episode_id
string

Responses

Request samples

Content type
application/json
{
  • "episode_id": 1,
  • "related_episode_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get an episode relation.

Get an episode relation.

path Parameters
id
required
string

Unique identifier for the episode relation.

query Parameters
status
string
Enum: "publish" "draft"

The result should be included the episodes in the published and draft status. As a public user you get only published episodes and the filter has no impact

Responses

Response samples

Content type
application/json
{
  • "version": "v2",
  • "episode_id": 1,
  • "related_episode_id": 3,
  • "related_episode_title": "Episode 3"
}

Modify an episode relation.

Modify an episode relation.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
object
episode_id
string
related_episode_id
string

Responses

Request samples

Content type
application/json
{
  • "episode_id": 1,
  • "related_episode_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify an episode relation.

Modify an episode relation.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
related
Array of integers or integer

Responses

Request samples

Content type
application/json
{
  • "related": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify an episode relation.

Modify an episode relation.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
object
episode_id
string
related_episode_id
string

Responses

Request samples

Content type
application/json
{
  • "episode_id": 1,
  • "related_episode_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete an episode relation.

Delete an episode relation.

path Parameters
id
required
string

Unique identifier for the episode relation

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes/tags

Get a list of tags to the episode.

Get a list of tags to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "tags": [
    ]
}

Set a tag or a list of tags to the episode.

Set a tag or a list of tags to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
term_id
integer

Responses

Request samples

Content type
application/json
{
  • "term_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Set a tag or a list of tags to the episode.

Set a tag or a list of tags to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
term_id
integer

Responses

Request samples

Content type
application/json
{
  • "term_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Set a tag or a list of tags to the episode.

Set a tag or a list of tags to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
term_id
integer

Responses

Request samples

Content type
application/json
{
  • "term_id": 5
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the tags to the episode. Only the links to

Delete the tags to the episode. Only the links to the tags will be deleted. The tags themselves are not removed.

path Parameters
id
required
string

Unique identifier for the episode

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes/contributions

A list of contributors who contribute to the episo

A list of contributors who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": [
    ]
}

Modify a list contributor who contribute to the ep

Modify a list contributor who contribute to the episode. The existing entries are deleted before the transferred entries are added.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
Array of objects[ items ]
Array
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Add a list contributor who contribute to the episo

Add a list contributor who contribute to the episode. The existing entries are deleted before the transferred entries are added.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
Array of objects[ items ]
Array
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify a list contributor who contribute to the ep

Modify a list contributor who contribute to the episode. The existing entries are deleted before the transferred entries are added.

path Parameters
id
required
string

UUnique identifier for the episode.

Request Body schema: application/json
Array of objects[ items ]
Array
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Remove all contributors who contribute to the epis

Remove all contributors who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A contributor who contribute to the episode.

A contributor who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the contribution.

Responses

Response samples

Content type
application/json
{
  • "id": 7,
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "Host of the episode."
}

Add a contributor who contribute to the episode.

Add a contributor who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the contribution.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Add a contributor who contribute to the episode.

Add a contributor who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the contribution.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Add a contributor who contribute to the episode.

Add a contributor who contribute to the episode.

path Parameters
id
required
string

UUnique identifier for the contribution.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

position
integer

Identifier to sort the contribution to an episode

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Remove a contributor who contribute to the episode

Remove a contributor who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the contribution.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

chapters

The list of chapters to an episode

The list of chapters to an episode

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{}

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application:/json
{
  • "status": "string"
}

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the chapters list for an epsiode.

Delete the chapters list for an epsiode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

transcripts

Returns the transcript of the episode.

Wihtout limit and offset, you get the whole transcript.

path Parameters
id
required
string

Unique identifier for the episode.

query Parameters
limit
string

How many entries should be delivered?

offset
string

From which entry should the data be delivered?

count
string

How many entries are there? Ignored limit and offset.

Responses

Response samples

Content type
application/json
{
  • "count": {
    },
  • "offset_limit": {
    },
  • "Transcripts": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Delete the transcript of an episode.

Delete the transcript of an episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

transcripts/voices

A list of the voices.

A list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

transcripts/paragraphs

A part of the transcription (called chaption).

A part of the transcription (called chaption).

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "start_ms": 5,
  • "end": "00:00:12.648",
  • "end_ms": 12648,
  • "voice": "Michi",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a chaption of the transcript

Delete a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

social

A list of supported social services.

A list of supported social services.

query Parameters
category
string
Enum: "social" "donation" "internal"

Select a category of social services

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

A supported social services.

A supported social services.

path Parameters
id
required
integer

Select a category of social services

Responses

Response samples

Content type
application/json
{}

social/contributors

A list of social services of a contributor.

A list of social services of a contributor.

path Parameters
id
required
integer

Identifier of the contributor

query Parameters
category
string

category: social, donation, internal

Responses

Response samples

Content type
application/json
[]

Add a social services of a contributor

Add a social services of a contributor

path Parameters
id
required
integer

Identifier of the contributor

query Parameters
category
string

category: social, donation, internal

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": 0
}

social/contributors/service

A social services of a contributor.

A social services of a contributor.

path Parameters
id
required
string

Social service id from the podcast

Responses

Response samples

Content type
application/json
{}

Modify a social service of a contributor.

Modify a social service of a contributor.

path Parameters
id
required
string

Identifier of the social service of a contributor.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor

service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify a social service of a contributor.

Modify a social service of a contributor.

path Parameters
id
required
string

Identifier of the social service of a contributor.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor

service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify a social service of a contributor.

Modify a social service of a contributor.

path Parameters
id
required
string

Identifier of the social service of a contributor.

Request Body schema: application/json
contributor_id
integer

Identifier of the contributor

service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a social service of a contributor

Delete a social service of a contributor

path Parameters
id
required
string

Identifier of the social service of a contributor

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

social/podcast

A list of social services from the podcast.

A list of social services from the podcast.

query Parameters
category
string

category: social, donation, internal

Responses

Response samples

Content type
application/json
[]

Add a social services for the podcast.

Add a social services for the podcast.

query Parameters
category
string

category: social, donation, internal

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": 0
}

social/podcast/service

A social services from the podcast.

A social services from the podcast.

path Parameters
id
required
string

Social service id from the podcast

Responses

Response samples

Content type
application/json
{}

Modify a social service from the podcast

Modify a social service from the podcast

path Parameters
id
required
string

Identifier of the social service from the podcast

Request Body schema: application/json
service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify a social service from the podcast

Modify a social service from the podcast

path Parameters
id
required
string

Identifier of the social service from the podcast

Request Body schema: application/json
service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Modify a social service from the podcast

Modify a social service from the podcast

path Parameters
id
required
string

Identifier of the social service from the podcast

Request Body schema: application/json
service_id
integer

Identifier of the service

account
string

Account value of the social service to create the account_url

title
string

Title of the service - contributor connection

position
integer

Identifier to sort the services from the contributor

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "service_id": 36,
  • "account": "podlove_org",
  • "title": "Podlove twitter account",
  • "position": 1
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a social service from the podcast

Delete a social service from the podcast

path Parameters
id
required
string

Identifier of the social service from the podcast

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

shownotes

A list of shownotes for an episode.

A list of shownotes for an episode.

query Parameters
episode_id
required
string

Limit result set by episode.

Responses

Response samples

Content type
application/json
[]

Add a shownotes item for an episode.

Add a shownotes item for an episode.

query Parameters
episode_id
required
string

Limit result set by episode.

type
required
string
Enum: "topic" "link"

Type of the created shownotes

title
required
string

Title of the created shownotes.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "episode_id": 2,
  • "type": "topic",
  • "state": "null",
  • "position": -2,
  • "unfurl_data": null,
  • "original_url": "null",
  • "affiliate_url": "null",
  • "url": "null",
  • "title": "Dieser Text gehört zu den Shownotes",
  • "description": "null",
  • "site_name": "null",
  • "site_url": "null",
  • "icon": "null",
  • "image": "null",
  • "created_at": "null",
  • "hidden": "null"
}

A shownote item for an episode.

A shownote item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "episode_id": 2,
  • "type": "topic",
  • "state": "null",
  • "position": -2,
  • "unfurl_data": null,
  • "original_url": "null",
  • "affiliate_url": "null",
  • "url": "null",
  • "title": "Dieser Text gehört zu den Shownotes",
  • "description": "null",
  • "site_name": "null",
  • "site_url": "null",
  • "icon": "null",
  • "image": "null",
  • "created_at": "null",
  • "hidden": "null"
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a shownotes item for an episode.

Delete a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Extract URL metadata

Uses the backend at https://plus.podlove.org/api/unfurl with the original_url of the entry to automatically set title, description, site name, site url, image and icon.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Import from OSF plugin

Generates shownotes entries from the "OSF" plugin.

query Parameters
post_id
required
integer

Releated post id to the episode.

Responses

Import from HTML

The HTML used is either the provided html parameter or the_content of the WordPress post.

Every link (a tag) encountered creates a shownotes entry of type link with the original_url set to its href attribute and the title set to the a content.

Every section heading (h1h6 tag) encountered creates a shownotes entry of type topic with the title set to the heading content.

query Parameters
html
string

html string. If not supplied, the content of the post is used.

Responses

contributors

A list of contributors of the podcast

If you are not authentificate, you will get only the visible contributors. The all filter will be ignored.

query Parameters
filter
Array of strings
Items Enum: "all" "visible"

The filter parameter is used to filter the collection of contributors.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": []
}

Add a contributor to the podcast.

Add a contributor to the podcast.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

A contributor of the podcast

If you are not authentificate, you will get only the information, if the contributor visible.

path Parameters
id
required
string

Unique identifier for contributor.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": []
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": "null",
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": "null",
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": "null",
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the information about a contributor.

Delete the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

contributors/groups

A list of groups to divide contributors by type of

A list of groups to divide contributors by type of participation.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "groups": [
    ]
}

Create a group of contributors.

Create a group of contributors.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get the information about a group of contributors.

Get the information about a group of contributors.

path Parameters
id
required
string

Unique identifier for contributor group.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a contributor group.

Delete a contributor group.

path Parameters
id
required
string

Unique identifier for contributor group.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

contributors/roles

A list of roles for contributors.

Use roles to assign a certain type of activity to a single contributor independent of any assigned group.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "roles": [
    ]
}

Create a role for contributors.

Create a role for contributors.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get the information about a role for contributors.

Get the information about a role for contributors.

path Parameters
id
required
string

Unique identifier for contributor role.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a contributor role.

Delete a contributor role.

path Parameters
id
required
string

Unique identifier for contributor role.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

contributors/defaults

A list of default contributors.

Default Contributors will be automatically added to the list of contributors for new episodes.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "defaults": [
    ]
}

Create a default contributors.

Create a default contributors.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Get the information about a default contributors.

Get the information about a default contributors.

path Parameters
id
required
integer

Unique identifier for default contributor.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Update the default contributor informations.

Update the default contributor informations.

path Parameters
id
required
integer

Unique identifier for default contributor.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the default contributor.

contributor_id
integer

Identifier of the contributor.

show_id
integer

Identifier of the show.

role_id
integer

Identifier of the contributor role.

group_id
integer

Identifier of the contributor group.

position
integer

Position of the default contributor in the list.

comment
string

Comment to the default contributor.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "contributor_id": 2,
  • "show_id": 0,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "null"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the default contributor informations.

Update the default contributor informations.

path Parameters
id
required
string

Unique identifier for default contributor.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the default contributor.

contributor_id
integer

Identifier of the contributor.

show_id
integer

Identifier of the show.

role_id
integer

Identifier of the contributor role.

group_id
integer

Identifier of the contributor group.

position
integer

Position of the default contributor in the list.

comment
string

Comment to the default contributor.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "contributor_id": 2,
  • "show_id": 0,
  • "role_id": 1,
  • "group_id": 1,
  • "position": 0,
  • "comment": "null"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the default contributor informations.

Update the default contributor informations.

path Parameters
id
required
integer

Unique identifier for default contributor.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the default contributor.

contributor_id
integer

Identifier of the contributor.

show_id
integer

Identifier of the show.

role_id
integer

Identifier of the contributor role.

group_id
integer

Identifier of the contributor group.

position
integer

Position of the default contributor in the list.

comment
string

Comment to the default contributor.

Responses

Request samples