API Catalog

Retrieve PY Work Location By Codes

06 Jan 2025
2 Minutes to read

Print
Dark
Light

Retrieve PY Work Location By Codes

Updated on 06 Jan 2025
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/hcm-rest-api/rest/1/pyworklocation

Query Standards

Finder

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

Find By Date
Primary Key

Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
auditDate	Create or Update Date Time Filter	2022-12-20

Primary Key

This is an optional finder for querying a specific Work Location Code by Primary Key (WrlCode)

Parameter	Description	Sample
WrlCode	Work Location Code	YORK

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate;auditDate=2015-01-01

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleWrlCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "WrlCode": "YORK",
      "WrlName": "York, PA",
      "WrlShortName": "York, PA",
      "WrlCountryCode": "US",
      "WrlCountryName": "United States of America",
      "WrlStateCode": "PA",
      "WrlStateName": "Pennsylvania",
      "WrlCountyCode": null,
      "WrlCountyName": null,
      "WrlCityCode": null,
      "WrlCityName": null,
      "WrlZipCode": "17406",
      "WrlStartZipCode": "17315 ",
      "WrlEndZipCode": "17408 ",
      "WrlVertexGeocode": "391334300",
      "WrlVertexSchdist": null,
      "WrlVertexPsdcode": null,
      "WrlUser": "DEMO",
      "WrlLastUpdDate": "2015-04-30T20:05:02Z",
      "WrlSickPolicyCode": null,
      "WrlRegionCode": null,
      "WrlIuCreateDate": "2015-04-30T20:05:02Z",
      "WrlIuCreateUser": "DEMO",
      "WrlIuUpdateDate": null,
      "WrlIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/YORK",
          "name": "pyworklocation",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/YORK",
          "name": "pyworklocation",
          "kind": "item"
        }
      ]
    },
    {
      "WrlCode": "8400",
      "WrlName": "Toledo, Ohio",
      "WrlShortName": "Toledo",
      "WrlCountryCode": "US",
      "WrlCountryName": "United States of America",
      "WrlStateCode": "OH",
      "WrlStateName": "Ohio",
      "WrlCountyCode": null,
      "WrlCountyName": null,
      "WrlCityCode": null,
      "WrlCityName": null,
      "WrlZipCode": "43601",
      "WrlStartZipCode": null,
      "WrlEndZipCode": null,
      "WrlVertexGeocode": "360952490",
      "WrlVertexSchdist": null,
      "WrlVertexPsdcode": null,
      "WrlUser": "DEMO",
      "WrlLastUpdDate": "2015-04-30T20:10:06Z",
      "WrlSickPolicyCode": null,
      "WrlRegionCode": null,
      "WrlIuCreateDate": "2015-04-30T20:10:06Z",
      "WrlIuCreateUser": "DEMO",
      "WrlIuUpdateDate": null,
      "WrlIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/8400",
          "name": "pyworklocation",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/8400",
          "name": "pyworklocation",
          "kind": "item"
        }
      ]
    },
    {
      "WrlCode": "ON",
      "WrlName": "Ontario",
      "WrlShortName": "ON",
      "WrlCountryCode": "CA",
      "WrlCountryName": "Canada",
      "WrlStateCode": "ON",
      "WrlStateName": "Ontario",
      "WrlCountyCode": "ON",
      "WrlCountyName": "Ontario",
      "WrlCityCode": "TO",
      "WrlCityName": "Toronto",
      "WrlZipCode": null,
      "WrlStartZipCode": null,
      "WrlEndZipCode": null,
      "WrlVertexGeocode": null,
      "WrlVertexSchdist": null,
      "WrlVertexPsdcode": null,
      "WrlUser": "ADWAIT",
      "WrlLastUpdDate": "2015-04-30T19:22:37Z",
      "WrlSickPolicyCode": null,
      "WrlRegionCode": null,
      "WrlIuCreateDate": "2015-04-30T19:22:37Z",
      "WrlIuCreateUser": "ADWAIT",
      "WrlIuUpdateDate": "2016-10-26T17:30:57Z",
      "WrlIuUpdateUser": "CANDICE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/ON",
          "name": "pyworklocation",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/ON",
          "name": "pyworklocation",
          "kind": "item"
        }
      ]
    },
    {
      "WrlCode": "QC",
      "WrlName": "Quebec",
      "WrlShortName": "QC",
      "WrlCountryCode": "CA",
      "WrlCountryName": "Canada",
      "WrlStateCode": "QC",
      "WrlStateName": "Quebec",
      "WrlCountyCode": null,
      "WrlCountyName": null,
      "WrlCityCode": null,
      "WrlCityName": null,
      "WrlZipCode": null,
      "WrlStartZipCode": null,
      "WrlEndZipCode": null,
      "WrlVertexGeocode": null,
      "WrlVertexSchdist": null,
      "WrlVertexPsdcode": null,
      "WrlUser": "ADWAIT",
      "WrlLastUpdDate": "2015-04-30T19:23:17Z",
      "WrlSickPolicyCode": null,
      "WrlRegionCode": null,
      "WrlIuCreateDate": "2015-04-30T19:23:17Z",
      "WrlIuCreateUser": "ADWAIT",
      "WrlIuUpdateDate": null,
      "WrlIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/QC",
          "name": "pyworklocation",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/QC",
          "name": "pyworklocation",
          "kind": "item"
        }
      ]
    },
    {
      "WrlCode": "BC",
      "WrlName": "British Columbia",
      "WrlShortName": "BC",
      "WrlCountryCode": "CA",
      "WrlCountryName": "Canada",
      "WrlStateCode": "BC",
      "WrlStateName": "British Columbia",
      "WrlCountyCode": null,
      "WrlCountyName": null,
      "WrlCityCode": null,
      "WrlCityName": null,
      "WrlZipCode": null,
      "WrlStartZipCode": null,
      "WrlEndZipCode": null,
      "WrlVertexGeocode": null,
      "WrlVertexSchdist": null,
      "WrlVertexPsdcode": null,
      "WrlUser": "ADWAIT",
      "WrlLastUpdDate": "2015-04-30T19:16:35Z",
      "WrlSickPolicyCode": null,
      "WrlRegionCode": null,
      "WrlIuCreateDate": "2015-04-30T19:16:35Z",
      "WrlIuCreateUser": "ADWAIT",
      "WrlIuUpdateDate": null,
      "WrlIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/BC",
          "name": "pyworklocation",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation/BC",
          "name": "pyworklocation",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyworklocation",
      "name": "pyworklocation",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific PY Trade Pay Rate By VUUID

Retrieve PY Work Location By Codes

Query Standards

Finder

Find By Date

Primary Key

What's Next

Contact Us