1 line
18 KiB
JSON
1 line
18 KiB
JSON
{"abstract":[{"text":"Get information about a listing in the marketplace.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getListing(path:query:headers:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getListing"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO6OutputO","text":"Output"}],"title":"getListing(path:query:headers:)","roleHeading":"Instance Method","externalID":"s:14DiscogsService11APIProtocolPAAE10getListing4path5query7headersAA10OperationsO03GetE0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","symbolKind":"method","extendedModule":"DiscogsService"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getListing","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetListing","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetListing","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Query-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO6OutputO","text":"Output","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"Views the data associated with a listing in the marketplace.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"In case of authenticated as an inventory owner, items that not only have the "},{"code":"For Sale","type":"codeVoice"},{"type":"text","text":" state will be shown as well as other extra fields in those items such as "},{"code":"weight","type":"codeVoice"},{"type":"text","text":", "},{"code":"format_quality","type":"codeVoice"},{"type":"text","text":", "},{"code":"external_id","type":"codeVoice"},{"text":", ","type":"text"},{"code":"location","type":"codeVoice"},{"type":"text","text":", and "},{"type":"codeVoice","code":"quantity_keys"},{"type":"text","text":". Note that the "},{"type":"codeVoice","code":"quantity"},{"type":"text","text":" field is read-only for "},{"inlineContent":[{"type":"text","text":"NearMint"}],"type":"emphasis"},{"type":"text","text":" users, who will see "},{"inlineContent":[{"type":"text","text":"1"}],"type":"emphasis"},{"type":"text","text":" for all quantity values, regardless of their actual count."}]},{"inlineContent":[{"type":"text","text":"In case the user is authorized, the listing will contain a "},{"type":"codeVoice","code":"in_cart"},{"type":"text","text":" boolean field indicating whether or not this listing is in their cart."}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/marketplace\/listings\/{listing_id}","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark","type":"aside","style":"note"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/listings\/{listing_id}\/get(getListing)"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside","style":"note"}]}],"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getlisting(path:query:headers:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlisting\/input\/query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"abstract":[],"title":"Operations.GetListing.Input.Query","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Query-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Input":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getlisting\/input","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","title":"Operations.GetListing.Input","type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Output":{"title":"Operations.GetListing.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlisting\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Output","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Input/Headers-swift.struct":{"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"title":"Operations.GetListing.Input.Headers","url":"\/documentation\/discogsservice\/operations\/getlisting\/input\/headers-swift.struct","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Headers-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing":{"title":"Operations.GetListing","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlisting","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetListing"}],"navigatorTitle":[{"kind":"identifier","text":"GetListing"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing","kind":"symbol","abstract":[{"type":"text","text":"Get information about a listing in the marketplace."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetListing/Input/Path-swift.struct":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getlisting\/input\/path-swift.struct","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetListing\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}],"role":"symbol","title":"Operations.GetListing.Input.Path","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Client/getListing(path:query:headers:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getListing","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"GetListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO","text":"GetListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV5QueryV"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO10GetListingO6OutputO"}],"kind":"symbol","role":"symbol","title":"getListing(path:query:headers:)","url":"\/documentation\/discogsservice\/client\/getlisting(path:query:headers:)","abstract":[{"text":"Get information about a listing in the marketplace.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getListing(path:query:headers:)"}}} |