{"swagger":"2.0","info":{"version":"1.0","title":"BC Gov News API Service 1.0","description":"News API","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"host": "news.api.gov.bc.ca","basePath":"/", "schemes": ["https"],"paths":{"/api/FacebookPosts/ByUri":{"get":{"tags":["FacebookPosts"],"summary":"Get a Facebook post based on a Uri","operationId":"FacebookPosts_GetByUri","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"uri","in":"query","description":"","required":false,"type":"string","default":""},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FacebookPost"}}}}},"/api/Home":{"get":{"tags":["Home"],"summary":"Returns the top level content for the home page","operationId":"Home_Get","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Home"}}}}},"/api/Ministries":{"get":{"tags":["Ministries"],"summary":"Get all ministries","operationId":"Ministries_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Ministry"}}}}}},"/api/Ministries/{key}":{"get":{"tags":["Ministries"],"summary":"Get the Ministry associated with the ministry key","operationId":"Ministries_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Ministry"}}}}},"/api/Ministries/{key}/Minister":{"get":{"tags":["Ministries"],"summary":"Get the Minister associated with the ministry key","operationId":"Ministries_GetMinister","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Minister"}}}}},"/api/Newsletters":{"get":{"tags":["Newsletters"],"summary":"Get all newsletters","operationId":"Newsletters_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Newsletter"}}}}}},"/api/Newsletters/{newsletterKey}":{"get":{"tags":["Newsletters"],"summary":"Get a specific newsletter","operationId":"Newsletters_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"newsletterKey","in":"path","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Newsletter"}}}}},"/api/Newsletters/{newsletterKey}/Editions/{editionKey}":{"get":{"tags":["Newsletters"],"summary":"Returns a specific edition of a newsletter","operationId":"Newsletters_GetEdition","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"newsletterKey","in":"path","description":"","required":true,"type":"string"},{"name":"editionKey","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Edition"}}}}},"/api/Newsletters/{newsletterKey}/Editions/{editionKey}/Articles/{articleKey}":{"get":{"tags":["Newsletters"],"summary":"Get an article belonging to a Newsletter edition","operationId":"Newsletters_GetArticle","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"newsletterKey","in":"path","description":"","required":true,"type":"string"},{"name":"editionKey","in":"path","description":"","required":true,"type":"string"},{"name":"articleKey","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Article"}}}}},"/api/Newsletters/Images/{guid}":{"get":{"tags":["Newsletters"],"summary":"Get the image object reference by of a Newsletter Edition associated with the image guid","operationId":"Newsletters_GetImage","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"guid","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EditionImage"}}}}},"/api/Posts/{key}":{"get":{"tags":["Posts"],"summary":"Get the post associated with the key","operationId":"Posts_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Post"}}}}},"/api/Posts":{"get":{"tags":["Posts"],"summary":"Get the posts associated with the keys in the list passed in.","operationId":"Posts_Get","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"postKeys","in":"query","description":"","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","default":""},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Post"}}}}}},"/api/Posts/Latest/{indexKind}/{indexKey}":{"get":{"tags":["Posts"],"summary":"Get the latest posts of postKind for the specified index (default or category)","operationId":"Posts_GetLatest","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"indexKind","in":"path","description":"home or one of categories","required":true,"type":"string"},{"name":"indexKey","in":"path","description":"default or one key of the categories (ministries, sectors, services, tags, themes)","required":true,"type":"string"},{"name":"postKind","in":"query","description":"One of: releases, stories, factsheets, updates or default (releases+stories except top/feature)","required":false,"type":"string","default":""},{"name":"count","in":"query","description":"number of posts to return","required":false,"type":"integer","format":"int32","default":""},{"name":"skip","in":"query","description":"number of posts to skip","required":false,"type":"integer","format":"int32","default":""},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Post"}}}}}},"/api/Posts/Keys/{indexKind}/{indexKey}":{"get":{"tags":["Posts"],"summary":"Get all keys for the specified index (newsroom or category)","operationId":"Posts_GetAllKeys","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"indexKind","in":"path","description":"home or one of categories","required":true,"type":"string"},{"name":"indexKey","in":"path","description":"default or one key of the categories (ministries, sectors, services, tags, themes)","required":true,"type":"string"},{"name":"postKind","in":"query","description":"One of: releases, stories, factsheets, updates or default (releases+stories+factsheets)","required":false,"type":"string","default":""},{"name":"count","in":"query","description":"number of posts to return","required":false,"type":"integer","format":"int32","default":""},{"name":"skip","in":"query","description":"number of posts to skip","required":false,"type":"integer","format":"int32","default":""},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/KeyValuePair`2"}}}}}},"/api/Posts/Keys/{reference}":{"get":{"tags":["Posts"],"summary":"Get the post key associated with the reference.","operationId":"Posts_GetKeyFromReference","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"reference","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KeyValuePair`2"}}}}},"/api/Posts/LatestMediaUri/{mediaType}":{"get":{"tags":["Posts"],"summary":"Gets the latest Social Media post for the social media type passed in.","operationId":"Posts_GetLatestMediaUri","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"mediaType","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}}}}},"/api/ResourceLinks":{"get":{"tags":["ResourceLinks"],"summary":"Get all resource links","operationId":"ResourceLinks_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/ResourceLink"}}}}}},"/api/Sectors":{"get":{"tags":["Sectors"],"summary":"Get all Sectors","operationId":"Sectors_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Sector"}}}}}},"/api/Sectors/{key}":{"get":{"tags":["Sectors"],"summary":"Get the sector associated with the key","operationId":"Sectors_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Sector"}}}}},"/api/Services":{"get":{"tags":["Services"],"summary":"Get all Services","operationId":"Services_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Service"}}}}}},"/api/Services/{key}":{"get":{"tags":["Services"],"summary":"Get the service associated with the passed key","operationId":"Services_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Service"}}}}},"/api/Slides/{id}":{"get":{"tags":["Slides"],"summary":"Get the slide associated to the id","operationId":"Slides_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Slide"}}}}},"/api/Slides":{"get":{"tags":["Slides"],"summary":"Get all Slides","operationId":"Slides_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Slide"}}}}}},"/api/Tags":{"get":{"tags":["Tags"],"summary":"Get all Tags","operationId":"Tags_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Tag"}}}}}},"/api/Tags/{key}":{"get":{"tags":["Tags"],"summary":"Get the Tag associated with the key","operationId":"Tags_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Tag"}}}}},"/api/Themes":{"get":{"tags":["Themes"],"summary":"Get all Themes","operationId":"Themes_GetAll","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#/definitions/Theme"}}}}}},"/api/Themes/{key}":{"get":{"tags":["Themes"],"summary":"Get the Theme associated with the key","operationId":"Themes_GetOne","consumes":[],"produces":["text/plain","application/json","text/json"],"parameters":[{"name":"key","in":"path","description":"","required":true,"type":"string"},{"name":"api-version","in":"query","description":"The requested API version","required":true,"type":"string","default":"1.0"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Theme"}}}}}},"definitions":{"FacebookPost":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"poster":{"type":"string"},"posterLogo":{"type":"string"},"posterSubtitle":{"type":"string"},"posterLikes":{"format":"int32","type":"integer"},"content":{"type":"string"},"postLikes":{"format":"int32","type":"integer"},"postComments":{"format":"int32","type":"integer"},"postShares":{"format":"int32","type":"integer"},"facebookObjectId":{"format":"int32","type":"integer"},"type":{"type":"string"},"pictureUri":{"type":"string"}}},"DataModel":{"type":"object","properties":{"key":{"type":"string"},"timestamp":{"format":"date-time","type":"string"}}},"Home":{"type":"object","allOf":[{"$ref":"#/definitions/DataIndex"}],"properties":{"liveWebcastFlashMediaManifestUrl":{"type":"string"},"liveWebcastM3uPlaylist":{"type":"string"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"DataIndex":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"kind":{"type":"string"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"Ministry":{"type":"object","allOf":[{"$ref":"#/definitions/Category"}],"properties":{"childMinistryKey":{"type":"string"},"parentMinistryKey":{"type":"string"},"ministryUrl":{"type":"string"},"displayAdditionalName":{"type":"string"},"topicLinks":{"type":"array","items":{"$ref":"#/definitions/ResourceLink"}},"serviceLinks":{"type":"array","items":{"$ref":"#/definitions/ResourceLink"}},"newsletterLinks":{"type":"array","items":{"$ref":"#/definitions/ResourceLink"}},"ministerName":{"type":"string"},"contactUser":{"$ref":"#/definitions/Contact"},"secondContactUser":{"$ref":"#/definitions/Contact"},"weekendContactNumber":{"type":"string"},"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"ResourceLink":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"uri":{"type":"string"}}},"Contact":{"type":"object","properties":{"fullName":{"type":"string"},"phoneNumber":{"type":"string"},"mobileNumber":{"type":"string"},"emailAddress":{"type":"string"}}},"Category":{"type":"object","allOf":[{"$ref":"#/definitions/DataIndex"}],"properties":{"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"Minister":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"headline":{"type":"string"},"summary":{"type":"string"},"details":{"type":"string"},"emailHtml":{"type":"string"},"photo":{"type":"string"},"post":{"type":"string"}}},"Newsletter":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"name":{"type":"string"},"ministryName":{"type":"string"},"description":{"type":"string"},"editions":{"type":"array","items":{"$ref":"#/definitions/KeyValuePair`2"}}}},"KeyValuePair`2":{"type":"object","properties":{"key":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true}}},"Edition":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"name":{"type":"string"},"htmlBody":{"type":"string"}}},"Article":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"editionName":{"type":"string"},"htmlBody":{"type":"string"}}},"EditionImage":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"fileName":{"type":"string"},"imageBytes":{"format":"byte","type":"string"},"imageType":{"type":"string"}}},"Post":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"kind":{"type":"string"},"atomId":{"type":"string"},"summary":{"type":"string"},"socialMediaSummary":{"type":"string"},"socialMediaHeadline":{"type":"string"},"keywords":{"type":"string"},"publishDate":{"format":"date-time","type":"string"},"leadMinistryKey":{"type":"string"},"hasMediaAssets":{"type":"boolean"},"isNewsOnDemand":{"type":"boolean"},"assetUrl":{"type":"string"},"location":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/definitions/Document"}},"reference":{"type":"string"},"redirectUri":{"type":"string"},"ministryKeys":{"type":"array","items":{"type":"string"}},"sectorKeys":{"type":"array","items":{"type":"string"}},"serviceKeys":{"type":"array","items":{"type":"string"}},"facebookPictureUri":{"type":"string"},"azureAssets":{"type":"array","items":{"$ref":"#/definitions/Asset"}}}},"Document":{"type":"object","properties":{"pageTitle":{"type":"string"},"languageId":{"format":"int32","type":"integer"},"headline":{"type":"string"},"subheadline":{"type":"string"},"detailsHtml":{"type":"string"},"byline":{"type":"string"},"contacts":{"type":"array","items":{"$ref":"#/definitions/DocumentContact"}}}},"DocumentContact":{"type":"object","properties":{"title":{"type":"string"},"details":{"type":"string"}}},"Asset":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"length":{"format":"int64","type":"integer"}}},"Sector":{"type":"object","allOf":[{"$ref":"#/definitions/Category"}],"properties":{"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"Service":{"type":"object","allOf":[{"$ref":"#/definitions/Category"}],"properties":{"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"Slide":{"type":"object","allOf":[{"$ref":"#/definitions/DataModel"}],"properties":{"slideId":{"format":"uuid","type":"string"},"headline":{"type":"string"},"summary":{"type":"string"},"actionLabel":{"type":"string"},"actionUri":{"type":"string"},"image":{"format":"byte","type":"string"},"facebookPostUri":{"type":"string"},"justify":{"type":"string"},"imageType":{"type":"string","readOnly":true}}},"Tag":{"type":"object","allOf":[{"$ref":"#/definitions/Category"}],"properties":{"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}},"Theme":{"type":"object","allOf":[{"$ref":"#/definitions/Category"}],"properties":{"twitterFeedUsername":{"type":"string"},"flickrUri":{"type":"string"},"youtubeUri":{"type":"string"},"audioUri":{"type":"string"},"isActive":{"type":"boolean"},"name":{"type":"string"},"topPostKey":{"type":"string"},"featurePostKey":{"type":"string"}}}},"securityDefinitions":{}}