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

{"metadata":{"role":"symbol","title":"getCharactersByEventId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByEventId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output"}],"extendedModule":"MarvelService","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE22getCharactersByEventId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByEventId(path:query:headers:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Headers-swift.struct"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of characters which appear in a specific event, with optional filters.","type":"text"}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/events\/{eventId}\/characters"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/events\/{eventId}\/characters\/get(getCharactersByEventId)"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcharactersbyeventid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Query"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","type":"topic","title":"Operations.getCharactersByEventId.Input.Query"},"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":{"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/getCharactersByEventId/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Input"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input","kind":"symbol","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","title":"Operations.getCharactersByEventId.Input","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/Client/getCharactersByEventId(path:query:headers:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByEventId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByEventId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output"}],"role":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"url":"\/documentation\/marvelservice\/client\/getcharactersbyeventid(path:query:headers:)","kind":"symbol","title":"getCharactersByEventId(path:query:headers:)"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Path-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/path-swift.struct","kind":"symbol","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Path-swift.struct","title":"Operations.getCharactersByEventId.Input.Path","abstract":[],"navigatorTitle":[{"text":"Path","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Headers-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Headers-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/headers-swift.struct","type":"topic","abstract":[],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Operations.getCharactersByEventId.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://MarvelService/documentation/MarvelService/Client":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","kind":"symbol","abstract":[{"type":"text","text":"The Marvel Comics RESTful API."}],"type":"topic","title":"Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/marvelservice\/client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getCharactersByEventId"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid","kind":"symbol","type":"topic","title":"Operations.getCharactersByEventId","abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","navigatorTitle":[{"kind":"identifier","text":"getCharactersByEventId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Output":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output","abstract":[],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"kind":"symbol","type":"topic","title":"Operations.getCharactersByEventId.Output"}}}