pellaea
commented
1 year ago Hi there,
The variable "name" in a POST request to observations is the scientific name. To get a full list of parameters do:
curl -X POST -F api_key=___ -F help=1 https://mushroomobserver.org/api2/observations
Here they are in the order they appear in the online form, with some extra help notes:
date: date (YYYY-MM-DD) location: place_name (e.g., "Pasadena, California, USA") is_collection_location: boolean (default, is this location where mushroom was found?) latitude: latitude longitude: longitude altitude: altitude gps_hidden: boolean (default=false, hide exact coordinates?) name: name (default=Fungi Bartl.) vote: float (default 3="I'd call it that", 2="probably", 1="could be", etc.) reason_1: string (recognized by sight, just send a string, if you include this parameter it's the same as checking the box, even if you pass an empty string) reason_2: string (used references) reason_3: string (micro features) reason_4: string (chemical features) has_specimen: boolean collectors_name: string collection_number: string herbarium: herbarium accession_number: string (unique fungarium id) notes: string notes[$field]: string (set value of the custom notes template field, substitute field name for "$field")
Other parameters you probably won't use:
images: image list (ids of images you have already uploaded, it's easier to create the obs first then upload images one at a time attaching each one to the obs as you go) thumbnail: image (id of one of the images you have already attached, this is really only used in PATCH requests) species_lists: species_list list (id, must have edit permission) projects: project list (id, must be member) initial_det: string (ignore this) source: enum (limit=mo_android_app|mo_api|mo_iphone_app|mo_website, default=mo_api) log: boolean (default, log this action on main page activity log and RSS feed?)
If sorry, yes, it looks like script/test_api has disappeared.
It looks like you can do uploads like this:
curl -X POST -F @.*** -F etc. https://mushroomobserver.org/api2/images
Let me know if that doesn't work.
I tried your test URL verbatim (replacing xxx with my api key) and it worked just fine. Can you give me your user id, and tell me approximately when you tried it, and I'll look it up in the log to see if I can figure out what went awry.
Did I miss anything?
-Jason
On Thu, Aug 17, 2023 at 1:54 AM fran-aubry @.***> wrote:
It looks like the documentation for adding an observation is incomplete. Could you please help me figure out the proper format of the URL?
Namely:
1.
The example url has a parameter named "name" while the online form https://mushroomobserver.org/observations/new request a "scientific name". Therefore, it is not obvious how each of the fields in the form should be named in the url. Could you provide a complete mapping? 2.
For fields like "Used references" it is unclear what should be sent. Both a string and a boolean if checked? Just a string? 3.
The readme refers to a file script/test_api to see how images should be encoded. However it seems that this file doesn't exist. 4.
I've made a few requests using my key in this url:
I got a 200 on each of them. However I don't see them when I go to the my observations page.
Thank you in advance for you help.
Best regards.
— Reply to this email directly, view it on GitHub https://github.com/MushroomObserver/mushroom-observer/issues/1558, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAYTNNMIKEPNU6EBVIDCL73XVWWZDANCNFSM6AAAAAA3TRHENE . You are receiving this because you are subscribed to this thread.Message ID: @.***>
fran-aubry
It looks like the documentation for adding an observation is incomplete. Could you please help me figure out the proper format of the URL?
Namely:
The example url has a parameter named "name" while the online form request a "scientific name". Therefore, it is not obvious how each of the fields in the form should be named in the url. Could you provide a complete mapping?
For fields like "Used references" it is unclear what should be sent. Both a string and a boolean if checked? Just a string?
The readme refers to a file
script/test_apito see how images should be encoded. However it seems that this file doesn't exist.I've made a few requests using my key in this url:
I got a 200 on each of them. However I don't see them when I go to the my observations page.
Thank you in advance for you help.
Best regards.