Podlove Publisher API (2)
Get download numbers per episode for all episodes.
Get download numbers per episode for all episodes.
query Parameters
| format | string |
Responses
Response samples
- 200
- 401
[- {
- "title": "Folge 2",
- "id": 2,
- "post_id": 25,
- "post_date": "2021-08-05T20:53:44.000Z",
- "post_date_gmt": "2021-08-05T20:53:44.000Z",
- "days_since_release": 207,
- "hours_since_release": 4967,
- "downloads": "3",
- "3y": 0,
- "2y": 0,
- "1y": 0,
- "3q": 0,
- "2q": 3,
- "1q": 3,
- "4w": 3,
- "3w": 3,
- "2w": 3,
- "1w": 3,
- "6d": 3,
- "5d": 3,
- "4d": 3,
- "3d": 3,
- "2d": 3,
- "1d": 3,
- "_links": {
}
}
]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
- 200
- 401
- 404
{- "title": "Folge 2",
- "id": 2,
- "post_id": 25,
- "post_date": "2021-08-05T20:53:44.000Z",
- "post_date_gmt": "2021-08-05T20:53:44.000Z",
- "days_since_release": 207,
- "hours_since_release": 4967,
- "downloads": "3",
- "3y": 0,
- "2y": 0,
- "1y": 0,
- "3q": 0,
- "2q": 3,
- "1q": 3,
- "4w": 3,
- "3w": 3,
- "2w": 3,
- "1w": 3,
- "6d": 3,
- "5d": 3,
- "4d": 3,
- "3d": 3,
- "2d": 3,
- "1d": 3,
- "_links": {
}
}Response samples
- 200
{- "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
- Payload
{- "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
- 401
{- "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
- Payload
{- "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
- 200
- 401
{- "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
- Payload
{- "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
- 200
- 401
{- "status": "ok"
}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 |
| show | string Filter by show slug. |
Responses
Response samples
- 200
{- "_version": "v2",
- "results": [
- {
- "id": 10,
- "title": "Folge 1"
}, - {
- "id": 11,
- "title": "Folge 2"
}
]
}The information about an episode
The information about an episode
path Parameters
| id required | string Unique identifier for the episode. |
Responses
Response samples
- 200
- 404
{- "_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": [
- {
- "size": 1502969,
- "title": "MP3 Audio (mp3)",
- "mimeType": "audio/mpeg"
}
], - "files": [
- {
- "size": 1502969,
- "title": "MP3 Audio (mp3)",
- "mimeType": "audio/mpeg"
}
], - "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
- Payload
{- "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
- 200
- 401
- 404
{- "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
- Payload
{- "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
- 200
- 401
- 404
{- "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
- Payload
{- "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
- 200
- 401
- 404
{- "status": "ok"
}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
- 200
- 404
{- "_version": "v2",
- "results": [
- {
- "asset_id": 1,
- "asset": "MP3 Audio",
- "size": 1502969,
- "enable": true
}, - {
- "asset_id": 2,
- "asset": "Podlove Simple Chapters",
- "enable": false
}
]
}Disable an episode asset
Disable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Disable an episode asset
Disable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Disable an episode asset
Disable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Enable an episode asset
Enable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Enable an episode asset
Enable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Enable an episode asset
Enable an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok"
}Verify an episode asset
Verify an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok",
- "file_size": 12596,
}Verify an episode asset
Verify an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok",
- "file_size": 12596,
}Verify an episode asset
Verify an episode asset
path Parameters
| id required | string Unique identifier for the episode. |
| asset_id required | string Unique identifier for the asset. Each asset in an episode's set of assets has an ID starting from 1 (e.g., the first asset has asset_id=1, the second asset has asset_id=2, and so on). |
Responses
Response samples
- 200
- 401
- 404
{- "status": "ok",
- "file_size": 12596,
}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
- 200
- 404
{- "_version": "v2",
- "contributors": [
- {
- "id": 7,
- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}, - {
- "id": 8,
- "contributor_id": 11,
- "role_id": 2,
- "group_id": 1,
- "position": 1,
- "comment": "Guest of the episode."
}
]
}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
| |||||||||||
Responses
Request samples
- Payload
{- "contributors": [
- {
- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}, - {
- "contributor_id": 11,
- "role_id": 2,
- "group_id": 1,
- "position": 1,
- "comment": "Guest of the episode."
}
]
}Response samples
- 200
- 401
- 404
{- "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
| |||||||||||
Responses
Request samples
- Payload
{- "contributors": [
- {
- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}, - {
- "contributor_id": 11,
- "role_id": 2,
- "group_id": 1,
- "position": 1,
- "comment": "Guest of the episode."
}
]
}Response samples
- 200
- 401
- 404
{- "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
- 200
- 404
{- "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
- Payload
{- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "contributor_id": 10,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "Host of the episode."
}Response samples
- 200
- 401
- 404
{- "status": "ok"
}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
- 200
- 404
{- "_version": "v2",
- "chapters": [
- {
- "start": "00:00:00",
- "title": "Intro"
}, - {
- "start": "00:00:50",
- "title": "Begrüßung",
}
]
}
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
- Payload
{- "_version": "v2",
- "chapters": [
- {
- "start": "00:00:00",
- "title": "Intro"
}, - {
- "start": "00:00:50",
- "title": "Begrüßung",
}
]
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "chapters": [
- {
- "start": "00:00:00",
- "title": "Intro"
}, - {
- "start": "00:00:50",
- "title": "Begrüßung",
}
]
}Response samples
- 201
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "chapters": [
- {
- "start": "00:00:00",
- "title": "Intro"
}, - {
- "start": "00:00:50",
- "title": "Begrüßung",
}
]
}Response samples
- 200
- 401
- 404
{- "status": "ok"
}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
- 200
- 404
{- "count": {
- "_version": "v2",
- "count": 723
}, - "offset_limit": {
- "_version": "v2",
- "prev": "podlove/v2/transcripts/2?offset=10?limit=10",
- "next": "podlove/v2/transcripts/2?offset=30?limit=10",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}, - "Transcripts": {
- "_version": "v2",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}
}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
- Payload
{- "type": "vtt",
- "content": "string"
}Response samples
- 200
- 401
- 404
- 500
{- "status": "ok",
- "transcript": {
- "count": {
- "_version": "v2",
- "count": 723
}, - "offset_limit": {
- "_version": "v2",
- "prev": "podlove/v2/transcripts/2?offset=10?limit=10",
- "next": "podlove/v2/transcripts/2?offset=30?limit=10",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}, - "Transcripts": {
- "_version": "v2",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}
}
}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
- Payload
{- "type": "vtt",
- "content": "string"
}Response samples
- 200
- 401
- 404
- 500
{- "status": "ok",
- "transcript": {
- "count": {
- "_version": "v2",
- "count": 723
}, - "offset_limit": {
- "_version": "v2",
- "prev": "podlove/v2/transcripts/2?offset=10?limit=10",
- "next": "podlove/v2/transcripts/2?offset=30?limit=10",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}, - "Transcripts": {
- "_version": "v2",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}
}
}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
- Payload
{- "type": "vtt",
- "content": "string"
}Response samples
- 200
- 401
- 404
- 500
{- "status": "ok",
- "transcript": {
- "count": {
- "_version": "v2",
- "count": 723
}, - "offset_limit": {
- "_version": "v2",
- "prev": "podlove/v2/transcripts/2?offset=10?limit=10",
- "next": "podlove/v2/transcripts/2?offset=30?limit=10",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}, - "Transcripts": {
- "_version": "v2",
- "transcript": [
- {
- "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."
}, - {
- "start": "00:00:14.385",
- "start_ms": 14385,
- "end": "00:00:15.376",
- "end_ms": 15376,
- "voice": "Michi",
- "text": "Hallo Eric"
}
]
}
}
}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
- 200
- 404
{- "_version": "v2",
- "voices": [
- {
- "voice": "Eric",
- "contributor_id": 10
}, - {
- "voice": "Alex",
- "contributor_id": 11
}
]
}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
- Payload
{- "_version": "v2",
- "voices": [
- {
- "voice": "Eric",
- "contributor_id": 10
}, - {
- "voice": "Alex",
- "contributor_id": 11
}
]
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "voices": [
- {
- "voice": "Eric",
- "contributor_id": 10
}, - {
- "voice": "Alex",
- "contributor_id": 11
}
]
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "voices": [
- {
- "voice": "Eric",
- "contributor_id": 10
}, - {
- "voice": "Alex",
- "contributor_id": 11
}
]
}Response samples
- 200
- 401
- 404
{- "status": "ok"
}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
- 200
- 404
{- "_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
- Payload
{- "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
- 200
- 401
- 404
{- "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
- Payload
{- "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
- 200
- 401
- 404
{- "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
- Payload
{- "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
- 200
- 401
- 404
{- "status": "ok"
}Response samples
- 200
{- "id": 1,
- "title": "My First Show",
- "subtitle": "",
- "slug": "my-first-show",
- "summary": "",
- "language": "de",
- "category": "",
- "auphonic_preset": ""
}
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
- 200
- 404
[- {
- "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"
}, - {
- "id": 6,
- "episode_id": 2,
- "type": "link",
- "state": "fetched",
- "position": 3,
- "unfurl_data": {
- "description": null,
- "embed": null,
- "icon": {
- "height": "32,",
- "type": "icon,",
- "width": 32
}, - "image": null,
- "screenshot_url": "https://plus.podlove.org/api/rest/v1/unfurl/screenshot?url=https%3A%2F%2Fpodlove.org",
- "site_name": "podlove.org",
- "title": "Podlove | Personal Media Development",
}, - "affiliate_url": null,
- "title": "Podlove | Personal Media Development,",
- "description": null,
- "site_name": "podlove.org",
- "image": null,
- "created_at": null,
- "hidden": null
}
]
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
- Payload
{- "original_url": "string",
- "title": "string",
- "url": "string",
- "description": "string",
- "position": 0,
- "hidden": "yes"
}Response samples
- 200
- 401
- 404
{- "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
- 200
- 404
{- "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
- Payload
{- "original_url": "string",
- "title": "string",
- "url": "string",
- "description": "string",
- "position": 0,
- "hidden": "yes"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "original_url": "string",
- "title": "string",
- "url": "string",
- "description": "string",
- "position": 0,
- "hidden": "yes"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "original_url": "string",
- "title": "string",
- "url": "string",
- "description": "string",
- "position": 0,
- "hidden": "yes"
}Response samples
- 200
- 401
- 404
{- "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 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 (h1–h6 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
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
- 200
{- "_version": "v2",
- "contributors": [
- {
- "id": 1,
- "identifier": "Dirk_Developer",
- "name": "Dirk",
- "mail": "null",
- "department": "Entwicklung",
- "organisation": "Podlove",
- "jobtitle": "Entwickler",
- "gender": "male",
- "nickname": "schumi",
- "count": 1
}
]
}
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
- 200
- 401
- 404
{- "_version": "v2",
- "contributors": [
- {
- "id": 1,
- "identifier": "Dirk_Developer",
- "name": "Dirk",
- "mail": "null",
- "department": "Entwicklung",
- "organisation": "Podlove",
- "jobtitle": "Entwickler",
- "gender": "male",
- "nickname": "schumi",
- "count": 1
}
]
}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. |
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. |
string e-mail of the contributor Do not use external. |
Responses
Request samples
- Payload
{- "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
- 200
- 401
- 404
{- "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. |
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. |
string e-mail of the contributor Do not use external. |
Responses
Request samples
- Payload
{- "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
- 200
- 401
- 404
{- "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. |
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. |
string e-mail of the contributor Do not use external. |
Responses
Request samples
- Payload
{- "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
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 2,
- "slug": "production",
- "title": "The group who are responsible for the production"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 2,
- "slug": "production",
- "title": "The group who are responsible for the production"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 2,
- "slug": "production",
- "title": "The group who are responsible for the production"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 1,
- "slug": "moderator",
- "title": "The moderator of the episode."
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 1,
- "slug": "moderator",
- "title": "The moderator of the episode."
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 1,
- "slug": "moderator",
- "title": "The moderator of the episode."
}Response samples
- 200
- 401
- 404
{- "status": "ok"
}A list of default contributors.
Default Contributors will be automatically added to the list of contributors for new episodes.
Responses
Response samples
- 200
{- "_version": "v2",
- "defaults": [
- {
- "id": 1,
- "contributor_id": 2,
- "show_id": 0,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "null"
}
]
}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
- Payload
{- "_version": "v2",
- "id": 1,
- "contributor_id": 2,
- "show_id": 0,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "null"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 1,
- "contributor_id": 2,
- "show_id": 0,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "null"
}Response samples
- 200
- 401
- 404
{- "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
- Payload
{- "_version": "v2",
- "id": 1,
- "contributor_id": 2,
- "show_id": 0,
- "role_id": 1,
- "group_id": 1,
- "position": 0,
- "comment": "null"
}Response samples
- 200
- 401
- 404
{- "status": "ok"
}