discogs-service/docs/data/documentation/discogsservice/client/getcollectionitemsbyfolder(path:query:headers:).json

{"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionItemsByFolder(path:query:headers:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionItemsByFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns the list of item in a specified collection folder of a user.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoint provides pagination parameters and also, requires authentication as an owner of a collection only in case the ","type":"text"},{"code":"folder_id","type":"codeVoice"},{"text":" is not ","type":"text"},{"code":"0","type":"codeVoice"},{"text":", or the collection has been made private by its owner. Otherwise, only public notes fields will be visible.","type":"text"}]},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/collection\/folders\/{folder_id}\/releases","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/get(getCollectionItemsByFolder)","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCollectionItemsByFolder"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO"}],"roleHeading":"Instance Method","role":"symbol","externalID":"s:14DiscogsService11APIProtocolPAAE26getCollectionItemsByFolder4path5query7headersAA10OperationsO03GetefgH0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","extendedModule":"DiscogsService","title":"getCollectionItemsByFolder(path:query:headers:)","symbolKind":"method","modules":[{"name":"DiscogsService"}]},"abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/getcollectionitemsbyfolder(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Path-swift.struct":{"type":"topic","navigatorTitle":[{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/path-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","kind":"symbol","title":"Operations.GetCollectionItemsByFolder.Input.Path"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetCollectionItemsByFolder.Input.Query","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetCollectionItemsByFolder.Output"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"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"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService/Client/getCollectionItemsByFolder(path:query:headers:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionItemsByFolder(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionItemsByFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"getCollectionItemsByFolder(path:query:headers:)","abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"url":"\/documentation\/discogsservice\/client\/getcollectionitemsbyfolder(path:query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"type":"topic","navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"title":"Operations.GetCollectionItemsByFolder","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input":{"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.GetCollectionItemsByFolder.Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Headers-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/headers-swift.struct","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"title":"Operations.GetCollectionItemsByFolder.Input.Headers"}}}