45
Devices API
There are two methods available for devices :
- List all devices
- Return full detail on a single device
List all devices
End Point: https://api.myposconnect.com/api/v2/devices
Verb: GET
Example Call: https://api.myposconnect.com/api/v2/devices?filt_LastEditDateUTC_dt_min=2022-jan-01%2009%3a00&filt_LastEditDateUTC_dt_max=2022-dec-31%2009%3a00
Return Codes: 200 for success, with the body containing the JSON for the Devices. For other possible (more general) return codes please see API Build Basics
Important: This call returns a restricted flat view of the Devices table. The JSON objects in the array are not full Devices JSON objects as shown in the appendices of this document. If some of the deeper information is required then you will need to use the method for getting a single device object. There are several query string arguments that can be used with this call as follows (you may need to URL encode your argument values).
Filters:
| filt_LastEditDate_dt_min | Optional DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDate” property. Example value of “2020-oct-06 11:10” would be URL encoded to “2020-oct-06%2011%3a10”. |
| filt_LastEditDate_dt_max | Optional UTC DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDate” property. |
|
filt_LastEditDateUTC_dt_min |
Optional UTC DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. Example value of “2020-oct-06 11:10” would be URL encoded to “2020-oct-06%2011%3a10”. |
|
filt_LastEditDateUTC_dt_max |
Optional UTC DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. |
| filt_storeid_guid | GUID of Store (StoreId) can be obtained by calling the Stores API Call |
|
filt_XXXXXXX_XXX |
Other filtering query string arguments may be available if requested, please let us know at [email protected]. |
Return full detail on a single device by Device Identifier DeviceId
End Point: https://api.myposconnect.com/api/v2/devices/{identifier}
Verb: GET
Example Call: https://api.myposconnect.com/api/v2/devices/72f0ba34-e233-4165-95d0-99b0b45364c3
Return Codes: 200 for success, with the body containing the JSON for the Device. For other possible (more general) return codes please see API Build Basics
Important: This call returns a view of a single Device and related fields including related custom fields tailored for individual MYPOS clients.
Example JSON Object
Single Device
|
|---|
Troubleshooting Ideas
As with all API connections, you will need to have acquired a bearer token and the user that acquired the token will need to be assigned access permission to this table. If you are not receiving any results send the full endpoint together with any filters and the API user to us from a valid email address and we can advise if permissions have been authorised. You might be able to see data with one table and not another if specific permissions are not applied. Check your filter dates if collecting all Devices.
