marvel-service/docs/data/documentation/marvelservice/client/getcharactersbyseriesid(path:query:headers:).json

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