API Catalog

Retrieve Equipment Home Locations By Code

26 Sep 2024
2 Minutes to read

Print
Dark
Light

Retrieve Equipment Home Locations By Code

Updated on 26 Sep 2024
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/em-rest-api/rest/1/emhomeloc

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

find by Code
find by Date
By UUID

Select by Code

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
locationCode	Location Code	001-CHI

Select by Date

This is an optional finder for Equipment Home Locations by Audit Date.

Parameter	Description	Sample
AuditDate	Create or update date time filter	2022-12-20

By UUID

This is an optional finder for querying a specific Equipment Home Location by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/em-rest-api/rest/1/emhomeloc/001-CHI

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByCode;locationCode=001-SF

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleEmhlHomelocCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - findByDate

{
  "items": [
    {
      "EmhlHomelocCode": "001-CHI",
      "EmhlName": "Chicago Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "001",
      "EmhlCompName": "CMiC Construction Inc",
      "EmhlDeptCode": "416",
      "EmhlDeptName": "Chicago Equip / Whse",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-CHI",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-CHI",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmhlHomelocCode": "001-SF",
      "EmhlName": "San Francisco Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "001",
      "EmhlCompName": "CMiC Construction Inc",
      "EmhlDeptCode": "716",
      "EmhlDeptName": "San Francisco Equip / Whse",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmhlHomelocCode": "001-EXT",
      "EmhlName": "External Customers",
      "EmhlSname": null,
      "EmhlCompCode": "001",
      "EmhlCompName": "CMiC Construction Inc",
      "EmhlDeptCode": "080",
      "EmhlDeptName": "Support Services",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-EXT",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-EXT",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmhlHomelocCode": "HIKUU- YRD",
      "EmhlName": "Company HIKUU Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "HIKUU",
      "EmhlCompName": "CMiC Construction Canada Ltd.",
      "EmhlDeptCode": "056",
      "EmhlDeptName": "Equipment/Warehouse Operations",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/HIKUU-%20YRD",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/HIKUU-%20YRD",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    },
    {
      "EmhlHomelocCode": "002-YARD",
      "EmhlName": "Company 002 Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "002",
      "EmhlCompName": "Fresenius Medical Care",
      "EmhlDeptCode": "056",
      "EmhlDeptName": "Equipment/Warehouse Operations",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/002-YARD",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/002-YARD",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc",
      "name": "emhomeloc",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - findByCode

{
  "items": [
    {
      "EmhlHomelocCode": "001-SF",
      "EmhlName": "San Francisco Yard / Warehouse",
      "EmhlSname": null,
      "EmhlCompCode": "001",
      "EmhlCompName": "CMiC Construction Inc",
      "EmhlDeptCode": "716",
      "EmhlDeptName": "San Francisco Equip / Whse",
      "EmhlIuCreateDate": "2015-05-11T03:03:28Z",
      "EmhlIuUpdateDate": null,
      "EmhlErecIncFlag": "N",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc/001-SF",
          "name": "emhomeloc",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/em-rest-api/rest/1/emhomeloc",
      "name": "emhomeloc",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve Equipment Rates by Row ID

Retrieve Equipment Home Locations By Code

Query Standards

Finder

Select by Code

Select by Date

By UUID

What's Next

Contact Us