Difference between revisions of "Create Custom List Item"
From MyMobileWorkers API
(Created page with "== Summary == A list item can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON conte...") |
|||
| Line 25: | Line 25: | ||
! | ! | ||
| update_existing || optional (default = false) | | update_existing || optional (default = false) | ||
| + | |- | ||
| + | ! Response | ||
| + | | colspan="2" | JSON | ||
| + | |} | ||
| + | |||
| + | ==== JSON As Body ==== | ||
| + | {| border="1" class="wikitable" | ||
| + | ! Create Item - JSON | ||
| + | ! colspan="2" | | ||
| + | |- | ||
| + | ! URL | ||
| + | | colspan="2" | https://base_url/api_path/version/list/item/create | ||
| + | |- | ||
| + | ! Type | ||
| + | | colspan="2" |POST | ||
| + | |- | ||
| + | ! | ||
| + | | JSON <br /> {key, update_existing(optional), items[]} ||| required | ||
|- | |- | ||
! Response | ! Response | ||
| colspan="2" | JSON | | colspan="2" | JSON | ||
|} | |} | ||
Revision as of 10:15, 28 July 2017
Summary
A list item can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.
The 'create item' method accepts an array of list items to be added to the system. If the 'update_existing' parameter is set, then any existing list items will be updated in the system. If set to false or not provided..
Multi Part Form Data
| Create Item | ||
|---|---|---|
| URL | http://base_url/api_path/version/list/item/create | |
| Type | POST | |
| Params: | api_key | required |
| file | required | |
| update_existing | optional (default = false) | |
| Response | JSON | |
JSON As Body
| Create Item - JSON | ||
|---|---|---|
| URL | https://base_url/api_path/version/list/item/create | |
| Type | POST | |
| JSON {key, update_existing(optional), items[]} |
required | |
| Response | JSON | |
