{"@context": "https://schema.org", "@type": "WebAPI", "name": "HHS Media Services API API", "description": "Common Features / Behaviors * \"sort\" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order. Examples: namesort results by name ascending -namesort results by name descending -name,idsort...", "provider": {"@type": "Organization", "name": "hhs.gov"}, "documentation": "https://api.digitalmedia.hhs.gov/swagger"}
Common Features / Behaviors * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order. Examples: namesort results by name ascending -namesort results by name descending -name,idsort...
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Common Features / Behaviors * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order. Examples: namesort results by name ascending -namesort results by name descending -name,idsort...
| method | path | what the vendor says it does |
|---|---|---|
GET | /resources.json | Get Resources by search query Global search resources |
GET | /resources/campaigns.json | Get Campaigns Media Listings for a specific campaign campaigns |
GET | /resources/campaigns/{id}.json | Get Campaign by ID Information about a specific campaign campaigns |
GET | /resources/campaigns/{id}/media.json | Get MediaItems by Campaign ID Campaign Listings campaigns |
GET | /resources/campaigns/{id}/syndicate.{format} | Get MediaItems for Campaign MediaItem campaigns |
GET | /resources/languages.json | Get Languages Language Listings languages |
GET | /resources/languages/{id}.json | Get Language by ID Information about a specific language languages |
GET | /resources/media.json | Get MediaItems Media Items Listings media |
GET | /resources/media/featured.json | Get the list of featured content in the syndication system Get the list of featured content in the syndication |
GET | /resources/media/mostPopularMedia.{format} | Get MediaItems by popularity Get the media with the highest ratings. media |
GET | /resources/media/searchResults.json | Get MediaItems by search query Full search media |
GET | /resources/media/{id}.json | Get MediaItem by ID Information about a specific media item media |
GET | /resources/media/{id}/content | Get content for MediaItem The actual media content (html, image, etc...) media |
GET | /resources/media/{id}/embed.json | Get embed code for MediaItem Get the javascript or iframe embed code for this item (to embed it on a web page) |
GET | /resources/media/{id}/preview.jpg | Get Tag by ID Get the jpg preview of the content item where applicable. media |
GET | /resources/media/{id}/relatedMedia.{format} | Get related MediaItems by ID Get the media related to the current media item. media |
GET | /resources/media/{id}/syndicate.{format} | Get syndicated content for MediaItem Get syndicated content. media |
GET | /resources/media/{id}/thumbnail.jpg | Get JPG thumbnail for MediaItem Get the jpg thumbnail of the content item where applicable. media |
GET | /resources/media/{id}/youtubeMetaData.json | Get Youtube metadata for MediaItem Youtube meta-data for a video item. media |
GET | /resources/mediaTypes.{format} | Get MediaTypes Information about media types mediaTypes |
GET | /resources/sources.json | Get Sources Source Listings sources |
GET | /resources/sources/{id}.json | Get Source by ID Information about a specific source. sources |
GET | /resources/sources/{id}/syndicate.{format} | Get MediaItems for Source MediaItem sources |
GET | /resources/tags.{format} | Get Tags List of Tags tags |
GET | /resources/tags/tagLanguages.{format} | Get TagLanguages List of Tag Languages tags |
GET | /resources/tags/tagTypes.{format} | Get MediaItems for Tag List of Types tags |
GET | /resources/tags/{id}.{format} | Get Tag by ID Information about a specific tag tags |
GET | /resources/tags/{id}/media.{format} | Get MediaItems for Tag MediaItem tags |
GET | /resources/tags/{id}/related.{format} | Get related Tags by ID Information about related tags to a specific tag tags |
GET | /resources/tags/{id}/syndicate.{format} | Get MediaItems for Tag MediaItem tags |
GET | /resources/userMediaLists/{id}.json | Get UserMediaList by ID Get a specific user media list. userMediaLists |
specification origin: https://api.digitalmedia.hhs.gov/swagger
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.