Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcharactersbyeventid(_:).json
T

1 line
9.6 KiB
JSON
Raw Normal View History

{"sections":[],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByEventId(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of characters which appear in a specific event, with optional filters.","type":"text"}]},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/events\/{eventId}\/characters","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","type":"aside"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/v1\/public\/events\/{eventId}\/characters\/get(getCharactersByEventId)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","type":"aside"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharactersbyeventid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","required":true,"role":"symbol","externalID":"s:13MarvelService11APIProtocolP22getCharactersByEventIdyAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getCharactersByEventId(_:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier","text":"getCharactersByEventId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","text":"Input","kind":"typeIdenti