Get Categories - Revision history

Ian: /* Example curl request */

2016-11-14T12:45:31Z

‎Example curl request

Darren.atherton: /* Response Parameters */

2013-08-12T11:33:55Z

‎Response Parameters

Darren.atherton at 11:21, 12 August 2013

2013-08-12T11:21:46Z

Darren.atherton: /* Example response */

2013-08-12T11:13:59Z

‎Example response

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Get All Categories ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/categories/all |- ! Type | c..."

2013-08-12T11:13:37Z

Created page with "== Summary == {| border="1" class="wikitable" ! Get All Categories ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/categories/all |- ! Type | c..."

New page

== Summary ==
{| border="1" class="wikitable"

! Get All Categories
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/categories/all
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
! Response
| colspan="2" | JSON
|}

The Get All Categories method returns all categories corresponding to the company making the method call.

== Response Parameters ==

== Example response ==
<source lang="java">
[
{
"name":"exampleCategory",
"external_id":"ss304"
},
{
"name":"test1",
"external_id":"exampleId"
},
{
"name":"test2",
"external_id":"exampleId"
}
]
</source>

== Example curl request ==

curl "http://live.mymobileworkers.com:8080/api/1/categories/all/?api_key=darrenwebapi"

← Older revision		Revision as of 12:45, 14 November 2016
Line 53:		Line 53:
	== Example curl request ==		== Example curl request ==

−	curl "http://~~live~~.mymobileworkers.com:8080/api/1/categories/all/?api_key=darrenwebapi"	+	curl "http://api.mymobileworkers.com:8080/api/1/categories/all/?api_key=darrenwebapi"

@@ Line 27: / Line 27: @@
 |-
 ! name
-| category name
+| Category name
 |-
 ! external_id

← Older revision		Revision as of 11:21, 12 August 2013
Line 21:		Line 21:

	== Response Parameters ==		== Response Parameters ==
		+	{\| border="1" class="wikitable"
		+
		+	! Field
		+	! Description
		+	\|-
		+	! name
		+	\| category name
		+	\|-
		+	! external_id
		+	\| Category external id
		+	\|}

	== Example response ==		== Example response ==

@@ Line 35: / Line 35: @@
+    {
        "name":"test2",
-       "external_id":"exampleId"
+       "external_id":"exampleId2"
+    }
+]