Difference between revisions of "Create Category"

Latest revision as of 12:44, 14 November 2016

[edit] Summary

The 'create category' method accepts an array of categories to be added to the system. A category 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.

If the 'update_existing' parameter is set, then any existing categories will be updated in the system. If set to false or not provided, then any category where the category name is not unique will be rejected.

If 'validate_only' is set, the items will only be validated but not actually inserted into the database. This can be used to check an entire dataset for errors before submitting.

[edit] Multi Part Form Data

[edit] JSON As Body

[edit] JSON Contents

[edit] Example Input

[edit] Multi Part Form Data

{"categories":[{
"external_id":"ss304",
"name":"exampleCategory"
}]}

[edit] JSON As Body

{
   "key":"darrenwebapi",
   "validate_only":"false",
   "update_existing":true,
   "categories":[
      {
         "external_id":"ss304",
         "name":"exampleCategory"
      }
   ]
}

[edit] Example Curl Requests

[edit] Multi Part Form Data

curl -F validate_only=false -F update_existing=true -F api_key=darrenwebapi -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_category.txt http://api.mymobileworkers.com:8080/api/1/categories

[edit] JSON As Body

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi", "validate_only":"false", "update_existing":true,"categories":[{"external_id":"ss304","name":"exampleCategory"}]}' http://api.mymobileworkers.com:8080/api/1/categories

[edit] Responses

[edit] Example JSON

{
	"successful":
	[
		{"name":"testCategory1"},
		{"name":"testCategory2"}
	],
	"failed":
	[
		{
			"name":"testCategory3",
			"errors": 
			[
				{
					"error_code":"CVA012",
					"error_msg":"name cannot be null."
				}
			]
		}
	]
}