Create Custom List Item - Revision history

Danielle: /* JSON As Body */

2018-03-12T11:39:09Z

‎JSON As Body

Danielle: /* JSON As Body */

2018-03-12T11:38:59Z

‎JSON As Body

Danielle: /* Multi Part Form Data */

2018-03-12T11:38:47Z

‎Multi Part Form Data

Danielle: /* JSON Contents */

2018-03-12T11:38:24Z

‎JSON Contents

DanielleH at 10:33, 28 July 2017

2017-07-28T10:33:02Z

DanielleH at 10:28, 28 July 2017

2017-07-28T10:28:00Z

DanielleH at 10:24, 28 July 2017

2017-07-28T10:24:00Z

DanielleH at 10:15, 28 July 2017

2017-07-28T10:15:25Z

DanielleH: 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..."

2017-07-28T10:14:36Z

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..."

New page

== 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 ====
{| border="1" class="wikitable"

! Create Item
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/list/item/create
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-
!
| update_existing || optional (default = false)
|-
! Response
| colspan="2" | JSON
|}

@@ Line 137: / Line 137: @@
 ==== JSON As Body ====
-curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi","update_existing":true,"items":[{"external_id":"ss303","name":"Rolfe Centre","notes":"Medium size","list_key":"site_list","order_position":1}]} https://api.mymobileworkers.com:8181/api/1/list/item/create
+curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi","update_existing":true,"items":[{"external_id":"ss303","name":"Rolfe Centre","notes":"Medium size","list_key":"site_list","order_position":1,"triggers": "photo,fail,note"}]} https://api.mymobileworkers.com:8181/api/1/list/item/create
 == Responses ==

@@ Line 121: / Line 121: @@
 "notes":"Medium size",
 "list_key":"site_list",
-"order_position": 1
+"order_position": 1,
+       }
+    ]
+}
 </source>
 == Example Curl Requests ==

@@ Line 104: / Line 104: @@
 "notes":"Medium size",
 "list_key":"site_list",
-"order_position": 1
+"order_position": 1,
 }]}
 </source>

@@ Line 71: / Line 71: @@
 |-
 ! external_id
 | varchar(255) ||
 |-

← Older revision		Revision as of 10:33, 28 July 2017
Line 90:		Line 90:
	\|-		\|-
	\|}		\|}
		+
		+	== Example Input ==
		+
		+	==== Multi Part Form Data ====
		+
		+	<source lang="java">
		+	{"items":[{
		+	"external_id":"ss303",
		+	"name":"Rolfe Centre",
		+	"notes":"Medium size",
		+	"list_key":"site_list",
		+	"order_position": 1
		+	}]}
		+	</source>
		+
		+	==== JSON As Body ====
		+
		+	<source lang="java">
		+	{
		+	"key":"darrenwebapi",
		+	"update_existing":true,
		+	"items":[
		+	{
		+	"external_id":"ss303",
		+	"name":"Rolfe Centre",
		+	"notes":"Medium size",
		+	"list_key":"site_list",
		+	"order_position": 1
		+	}
		+	]
		+	}
		+	</source>
		+
		+
		+	== Example Curl Requests ==
		+
		+	==== Multi Part Form Data ====
		+
		+	curl -F update_existing=true -F api_key=darrenwebapi -F
		+	file=@/Users/darrenatherton/Desktop/webAPICurling/create_item.txt https://api.mymobileworkers.com:8181/api/1/list/item/create
		+
		+	==== JSON As Body ====
		+
		+	curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi","update_existing":true,"items":[{"external_id":"ss303","name":"Rolfe Centre","notes":"Medium size","list_key":"site_list","order_position":1}]} https://api.mymobileworkers.com:8181/api/1/list/item/create
		+
		+	== Responses ==
		+
		+	=== Example JSON ===
		+
		+	<source lang="java">
		+	{
		+	"failed": [],
		+	"successful": [
		+	{
		+	"item_name": "Rolfe Centre"
		+	}
		+	]
		+	}
		+	</source>

@@ Line 59: / Line 59: @@
 |-
 ! list_key
-| float(10,2) || &#10003;
+| varchar(255) ||
 |-
 ! name
-| float(10,2) || &#10003;
+| varchar(255) || &#10003;
 |-
 ! notes
@@ Line 68: / Line 68: @@
 |-
 ! order_position
-| text ||
+| int(11) ||
 |-
 ! external_id
-| varchar(45) ||
+| varchar(255) ||
 |-
 |}

@@ Line 46: / Line 46: @@
 ! Response
 | colspan="2" | JSON
 |}