marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcharactersbyseriesid(_:).json

{"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersBySeriesId(_:)"},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","text":"getCharactersBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input","text":"Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","text":"getCharactersBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output","text":"Output","kind":"typeIdentifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"inlineContent":[{"type":"text","text":"Fetches lists of characters which appear in specific series, with optional filters."}],"type":"paragraph"},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/series\/{seriesId}\/characters"},{"type":"text","text":"."}]}]},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/characters\/get(getCharactersBySeriesId)"},{"type":"text","text":"."}]}],"type":"aside","name":"Remark"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharactersbyseriesid(_:)"]}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by a series id."}],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"symbolKind":"method","externalID":"s:13MarvelService11APIProtocolP23getCharactersBySeriesIdyAA10OperationsOADO6OutputOAG5InputVYaKF","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersBySeriesId"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","text":"getCharactersBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","text":"getCharactersBySeriesId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO","text":"Output","kind":"typeIdentifier"}],"title":"getCharactersBySeriesId(_:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"references":{"doc://MarvelService/documentation/MarvelService/APIProtocol/getCharactersBySeriesId(_:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersBySeriesId(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersBySeriesId"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","kind":"typeIdentifier","text":"getCharactersBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","kind":"typeIdentifier","text":"getCharactersBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"required":true,"role":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a series id."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcharactersbyseriesid(_:)","kind":"symbol","title":"getCharactersBySeriesId(_:)"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a series id."}],"type":"topic","title":"Operations.getCharactersBySeriesId","navigatorTitle":[{"text":"getCharactersBySeriesId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersBySeriesId","kind":"identifier"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService":{"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","abstract":[{"type":"text","text":"A library that allows the developer to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Marvel Comics API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/marvelservice","type":"topic","title":"MarvelService"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Output","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getCharactersBySeriesId.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","title":"APIProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations":{"role":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","title":"Operations","url":"\/documentation\/marvelservice\/operations"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input":{"title":"Operations.getCharactersBySeriesId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input","abstract":[],"kind":"symbol","type":"topic"}}}