Difference between revisions of "Get Assets Assigned To Customer"

From MyMobileWorkers API
Jump to: navigation, search
(Created page with "== Summary == {| border="1" class="wikitable" ! Asset ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_number=SERI...")
 
(→‎Example curl request)
 
(4 intermediate revisions by one user not shown)
Line 2: Line 2:
 
{| border="1" class="wikitable"
 
{| border="1" class="wikitable"
  
−
! Asset
+
! Asset by customer 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
+
−
|-
+
−
!
+
−
| serial_number || required
+
−
|-
+
−
! Response
+
−
| colspan="2" | JSON
+
−
|}
+
−
 
+
−
The Get Asset method returns the asset corresponding to the serial number specified.
+
−
 
+
−
== Response Parameters ==
+
−
{| border="1" class="wikitable"
+
−
 
+
−
! Field
+
−
! Description
+
−
|-
+
−
! location
+
−
| Asset location
+
−
|-
+
−
|-
+
−
! status
+
−
| Contains both external id and status name for asset status
+
−
|-
+
−
|-
+
−
! description
+
−
| Asset description
+
−
|-
+
−
|-
+
−
! item
+
−
| Contains the name, category and external id of the item the asset is linked to
+
−
|-
+
−
! serial_number
+
−
| Asset serial number
+
−
|-
+
−
! created_at
+
−
| Date asset was created
+
−
|-
+
−
! last_updated_by
+
−
| User who last updated asset
+
−
|-
+
−
! external_id
+
−
| Asset external id
+
−
|-
+
−
! last_scanned_by
+
−
| User who last scanned asset
+
−
|-
+
−
! custom_fields
+
−
| Asset custom fields
+
−
|-
+
−
! last_updated_by
+
−
| User who last updated asset
+
−
|-
+
−
! job
+
−
| Job the asset is linked to
+
−
|-
+
−
! customer
+
−
| Customer the asset is linked to
+
−
|-
+
−
|}
+
−
 
+
−
== Example response ==
+
−
<source lang="java">
+
−
[
+
−
{
+
−
"location":"aPlace",
+
−
"status":{
+
−
"external_id":null,
+
−
"name":"test"
+
−
},
+
−
"description":"describingwords",
+
−
"item":{
+
−
"external_id":null,
+
−
"category":"Test Numero 1",
+
−
"name":"Woo
+
−
"},
+
−
"serial_number":"serialNo123",
+
−
"created_at":1375786053000,
+
−
"last_updated_by":null,
+
−
"external_id":"sss32",
+
−
"last_scanned_by":null,
+
−
"custom_fields":null,
+
−
"job":{
+
−
"job_ number":"123"},
+
−
"customer":{
+
−
"name":"john"
+
−
}
+
−
}
+
−
]
+
−
</source>
+
−
 
+
−
== Example curl request ==
+
−
 
+
−
== Summary ==
+
−
{| border="1" class="wikitable"
+
−
 
+
−
! Asset
+
 
! colspan="2" |  
 
! colspan="2" |  
 
|-
 
|-
Line 176: Line 70:
 
! customer
 
! customer
 
| Customer the asset is linked to
 
| Customer the asset is linked to
 +
|-
 +
! branch
 +
| Branch the asset is linked to
 
|-
 
|-
 
|}
 
|}
Line 182: Line 79:
 
<source lang="java">
 
<source lang="java">
 
{
 
{
−
   "assets":[
+
   "location":"aPlace2",
−
      {
+
  "status":{
−
        "location":"aPlace2",
+
      "external_id":null,
−
        "status":{
+
      "name":"test"
−
            "external_id":null,
+
  },
−
            "name":"test"
+
  "description":"describingwords",
−
        },
+
  "item":{
−
        "description":"describingwords",
+
      "external_id":null,
−
        "item":{
+
      "category":"test3",
−
            "external_id":null,
+
      "name":"Woo"
−
            "category":"Test Numero 1",
+
  },
−
            "name":"Woo"
+
  "serial_number":"serialNo456",
−
        },
+
  "created_at":"2013-10-08 14:19:17",
−
        "serial_number":"serialNo123",
+
  "last_updated_by":null,
−
        "created_at":1375874083000,
+
  "external_id":"sss32",
−
        "last_updated_by":null,
+
  "last_scanned_by":null,
−
        "external_id":"sss32",
+
  "job":{
−
        "last_scanned_by":null,
+
      "job_ number":"123"
−
        "custom_fields":null,
+
  },
−
        "job":{
+
  "customer":{
−
            "job_ number":"123"
+
      "name":"john"
−
        },
+
  },
−
        "customer":{
+
  "custom_fields":{
−
            "name":"john"
+
      "testFieldName3":"testFieldValue3",
−
        }
+
      "testFieldName2":"testFieldValue2",
−
      },
+
      "testFieldName1":"testFieldValue1"
−
      {
+
  },
−
        "location":"aPlace2",
+
  "branch":{
−
        "status":{
+
      "name":"DarrenDevTest"
−
            "external_id":null,
+
  }
−
            "name":"test"
+
−
        },
+
−
        "description":"describingwords",
+
−
        "item":{
+
−
            "external_id":null,
+
−
            "category":"Test Numero 1",
+
−
            "name":"Woo"
+
−
        },
+
−
        "serial_number":"serialNo456",
+
−
        "created_at":1375888861000,
+
−
        "last_updated_by":null,
+
−
        "external_id":"sss32",
+
−
        "last_scanned_by":null,
+
−
        "custom_fields":null,
+
−
        "job":{
+
−
            "job_ number":"123"
+
−
        },
+
−
        "customer":{
+
−
            "name":"john"
+
−
        }
+
−
      }
+
−
  ]
+
 
}
 
}
 
</source>
 
</source>
Line 239: Line 114:
 
== Example curl request ==
 
== Example curl request ==
  
−
curl "http://live.mymobileworkers.com:8080/api/1/assets/asset/customer/?api_key=darrenwebapi&customer=john"
+
curl "http://api.mymobileworkers.com:8080/api/1/assets/asset/customer/?api_key=darrenwebapi&customer=john"

Latest revision as of 12:39, 14 November 2016

Contents

[edit] Summary

Asset by customer name
URL http://:base_url/:api_path/:version/asset/customer?api_key=YOUR_KEY&customer=CUSTOMER
Type GET
Params: api_key required
customer required
Response JSON

The Get Assets Assigned To Customer method returns the list of assets assigned to the customer name provided in the parameter.

[edit] Response Parameters

Field Description
location Asset location
status Contains both external id and status name for asset status
description Asset description
item Contains the name, category and external id of the item the asset is linked to
serial_number Asset serial number
created_at Date asset was created
last_updated_by User who last updated asset
external_id Asset external id
last_scanned_by User who last scanned asset
custom_fields Asset custom fields
last_updated_by User who last updated asset
job Job the asset is linked to
customer Customer the asset is linked to
branch Branch the asset is linked to

[edit] Example response 

{
   "location":"aPlace2",
   "status":{
      "external_id":null,
      "name":"test"
   },
   "description":"describingwords",
   "item":{
      "external_id":null,
      "category":"test3",
      "name":"Woo"
   },
   "serial_number":"serialNo456",
   "created_at":"2013-10-08 14:19:17",
   "last_updated_by":null,
   "external_id":"sss32",
   "last_scanned_by":null,
   "job":{
      "job_ number":"123"
   },
   "customer":{
      "name":"john"
   },
   "custom_fields":{
      "testFieldName3":"testFieldValue3",
      "testFieldName2":"testFieldValue2",
      "testFieldName1":"testFieldValue1"
   },
   "branch":{
      "name":"DarrenDevTest"
   }
}

[edit] Example curl request

curl "http://api.mymobileworkers.com:8080/api/1/assets/asset/customer/?api_key=darrenwebapi&customer=john"

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

Variants
Actions
Navigation
Toolbox