@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api HHS Media Services API
@version 2
@endpoints 31
@hint download_for_search
@toc resources.json(1), resources(30)

@group resources.json
@endpoint GET /resources.json
@required {q: any}
@returns(200)
@errors {400, 500}

@endgroup

@group resources
@endpoint GET /resources/campaigns.json
@optional {max: any, offset: any, sort: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/campaigns/{id}.json
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/campaigns/{id}/media.json
@required {id: any}
@optional {sort: any, max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/campaigns/{id}/syndicate.{format}
@required {id: any}
@optional {displayMethod: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/languages.json
@optional {max: any, offset: any, sort: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/languages/{id}.json
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media.json
@optional {max: any, offset: any, sort: any, order: any, mediaTypes: any, name: any, collectionId: any, nameContains: any, descriptionContains: any, sourceUrl: any, sourceUrlContains: any, customThumbnailUrl: any, customThumbnailUrlContains: any, dateContentAuthored: any, dateContentUpdated: any, dateContentPublished: any, dateContentReviewed: any, dateSyndicationCaptured: any, dateSyndicationUpdated: any, contentAuthoredSinceDate: any, contentAuthoredBeforeDate: any, contentAuthoredInRange: any, contentUpdatedSinceDate: any, contentUpdatedBeforeDate: any, contentUpdatedInRange: any, contentPublishedSinceDate: any, contentPublishedBeforeDate: any, contentPublishedInRange: any, contentReviewedSinceDate: any, contentReviewedBeforeDate: any, contentReviewedInRange: any, syndicationCapturedSinceDate: any, syndicationCapturedBeforeDate: any, syndicationCapturedInRange: any, syndicationUpdatedSinceDate: any, syndicationUpdatedBeforeDate: any, syndicationUpdatedInRange: any, syndicationVisibleSinceDate: any, syndicationVisibleBeforeDate: any, syndicationVisibleInRange: any, languageId: any, languageName: any, languageIsoCode: any, hash: any, hashContains: any, sourceId: any, sourceName: any, sourceNameContains: any, sourceAcronym: any, sourceAcronymContains: any, tagIds: any, restrictToSet: any, createdBy: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/featured.json
@optional {sort: any, max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/mostPopularMedia.{format}
@optional {max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/searchResults.json
@required {q: any}
@optional {max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}.json
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/content
@required {id: any}
@optional {calledByBuild: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/embed.json
@required {id: any}
@optional {flavor: any, width: any, height: any, iframeName: any, excludeJquery: any, excludeDiv: any, divId: any, displayMethod: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/preview.jpg
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/relatedMedia.{format}
@required {id: any}
@optional {max: any, offset: any, sort: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/syndicate.{format}
@required {id: any}
@optional {cssClass: any, stripStyles: any, stripScripts: any, stripImages: any, stripBreaks: any, stripClasses: any, font-size: any, imageFloat: any, imageMargin: any, autoplay: any, rel: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/thumbnail.jpg
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/media/{id}/youtubeMetaData.json
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/mediaTypes.{format}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/sources.json
@optional {max: any, offset: any, sort: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/sources/{id}.json
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/sources/{id}/syndicate.{format}
@required {id: any}
@optional {displayMethod: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags.{format}
@optional {sort: any, max: any, offset: any, name: any, nameContains: any, mediaId: any, typeId: any, typeName: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/tagLanguages.{format}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/tagTypes.{format}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/{id}.{format}
@required {id: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/{id}/media.{format}
@required {id: any}
@optional {sort: any, max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/{id}/related.{format}
@required {id: any}
@optional {sort: any, max: any, offset: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/tags/{id}/syndicate.{format}
@required {id: any}
@optional {displayMethod: any}
@returns(200)
@errors {400, 500}

@endpoint GET /resources/userMediaLists/{id}.json
@required {id: any}
@optional {displayMethod: any}
@returns(200)
@errors {400, 500}

@endgroup

@end