Get Item By Name - Revision history

Ian: /* Example curl request */

2016-11-14T12:41:57Z

‎Example curl request

Darren.atherton: /* Response Parameters */

2013-08-12T11:41:14Z

‎Response Parameters

Darren.atherton: /* Summary */

2013-08-08T14:03:43Z

‎Summary

Darren.atherton: /* Summary */

2013-08-08T14:03:25Z

‎Summary

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Item by name ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_numb..."

2013-08-08T14:02:38Z

Created page with "== Summary == {| border="1" class="wikitable" ! Item by name ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_numb..."

New page

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

! Item by name
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_number=SERIAL_NUMBER
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
!
| item_name || required
|-
! Response
| colspan="2" | JSON
|}

The Get Item By Name method returns the item corresponding to the item name provided.

== Response Parameters ==

== Example response ==
<source lang="java">
{
"name":"darrenItem",
"category":{
"external_id":"",
"name":"Test1"
},
"notes":"notes",
"external_id":"ss303",
"product_code":"productCodeTest",
"price":2.5
}
</source>

== Example curl request ==

curl "http://live.mymobileworkers.com:8080/api/1/items/item/name/?api_key=darrenwebapi&item_name=darrenItem"

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

−	curl "http://~~live~~.mymobileworkers.com:8080/api/1/items/item/name/?api_key=darrenwebapi&item_name=darrenItem"	+	curl "http://api.mymobileworkers.com:8080/api/1/items/item/name/?api_key=darrenwebapi&item_name=darrenItem"

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

	== Response Parameters ==		== Response Parameters ==
		+	{\| border="1" class="wikitable"
		+
		+	! Field
		+	! Description
		+	\|-
		+	! name
		+	\| Item name
		+	\|-
		+	\|-
		+	! category
		+	\| Contains both category name and id for item
		+	\|-
		+	\|-
		+	! notes
		+	\| Item notes
		+	\|-
		+	\|-
		+	! price
		+	\| Item price
		+	\|-
		+	! external_id
		+	\| Item external id
		+	\|-
		+	! product_code
		+	\| Item product code
		+	\|-
		+	\|}

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

@@ Line 6: / Line 6: @@
 |-
 ! URL
-| colspan="2" |  http://:base_url/:api_path/:version/items/item/name?api_key=YOUR_KEY&serial_number=SERIAL_NUMBER
+| colspan="2" |  http://:base_url/:api_path/:version/items/item/name?api_key=YOUR_KEY&item_name=ITEM_NAME
 |-
 ! Type