Difference between revisions of "Get Asset"

From MyMobileWorkers API
Jump to: navigation, search
(Created page with "== Summary == {| border="1" class="wikitable" ! Mobile Users ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/mobile_users |- ! Type | colspan="...")
 
Line 2: Line 2:
 
{| border="1" class="wikitable"
 
{| border="1" class="wikitable"
  
−
! Mobile Users
+
! Asset
 
! colspan="2" |  
 
! colspan="2" |  
 
|-
 
|-
 
! URL
 
! URL
−
| colspan="2" |  http://:base_url/:api_path/:version/mobile_users
+
| colspan="2" |  http://:base_url/:api_path/:version/asset
 
|-
 
|-
 
! Type
 
! Type
Line 15: Line 15:
 
|-
 
|-
 
!  
 
!  
−
| branch_id || optional
+
| serial_number || required
 
|-
 
|-
 
! Response
 
! Response
Line 22: Line 22:
  
  
−
The mobile users method returns a list of all mobile users for your company unless the branch id is specified.
+
The Get Asset method returns the asset corresponding to the serial number specified.
  
  
 
== Response Parameters ==
 
== Response Parameters ==
−
{| border="1" class="wikitable"
 
−
 
−
! Field
 
−
! Description
 
−
|-
 
−
! username
 
−
| Mobile username
 
−
|-
 
−
|-
 
−
! email_address
 
−
| Email address
 
−
|-
 
−
|-
 
−
! color
 
−
| Hex Colour used within MMW to identify the user (see the calendar)
 
−
|-
 
−
|-
 
−
! engineer_registration_number
 
−
| The users gas safe engineer ID if provided.
 
−
|-
 
−
|}
 
  
 
== Example response ==
 
== Example response ==
 
<source lang="java">
 
<source lang="java">
 
[
 
[
−
{"username":"USER1","email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null},
+
 
−
{"username":"USER2","email":"bobbob@nospam.com","color":"97326A","engineer_registration_number":null},
+
−
{"username":"USER3","email":"sdfasdf@nospam.com","color":"56500D","engineer_registration_number":null},
+
−
{"username":"USER4","email":"asdsdf@nospam.com","color":"C1C355","engineer_registration_number":null},
+
−
{"username":"USER5","email":"asdfds@nospam.com","color":"FA556A","engineer_registration_number":null}
+
 
]
 
]
 
</source>
 
</source>
Line 61: Line 36:
 
== Example curl request ==
 
== Example curl request ==
  
−
http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY
+
http://live.mymobileworkers.com:8080/api/1/assets?api_key=YOURAPIKEY

Revision as of 12:33, 6 August 2013

Contents

Summary

Asset
URL http://:base_url/:api_path/:version/asset
Type GET
Params: api_key required
serial_number required
Response JSON


The Get Asset method returns the asset corresponding to the serial number specified.


Response Parameters

Example response 

[
 
]

Example curl request

http://live.mymobileworkers.com:8080/api/1/assets?api_key=YOURAPIKEY

Retrieved from ‘https://docs.mymobileworkers.com/index.php?title=Get_Asset&oldid=328’
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox