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

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