collection.export
Description
Export whole collection in given format. Waits at most options.wait
seconds for the export to finish,
then gives up. You can later query for export status by calling export.query()
method
and retrieve the exported file using export.get()
method.
Params
- token
- string
-
Access token.
- options
- struct
-
Export options
- format
- string
- enum
-
Format of exported file.
Value Description html
HTML table with images
csv
GeoGet CSV
svetgc
XML file compatibile with former SvetGC export.
fullxml
Full XML with all information.
fullcsv
CSV file with all collection information.
- wait
- int
- optional
-
Maximum number of seconds to wait for export to finish until this method finishes. If not specified, will not wait for export to finish and return immediately.
Response
- response
- struct
-
- status
- int
- enum
-
Status code
Value Description 200
Export finished and is available for download
202
Export has been queued for processing, however it did not finished in given wait period.
400
Bad params
500
Server error
- statusMessage
- string
-
Status code description
- exportId
- int
-
ID of export to use when requesting status or downloading the exported file.
Call example
collection.export("dolore eu fugiat", {"format": "svetgc", "wait": 1262931925})