> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve PY Work Location By Codes > ## 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 | ## OpenAPI ````json GET /hcm-rest-api/rest/1/pyworklocation { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/hcm-rest-api/rest/1/pyworklocation": { "get": { "tags": [ "HCM | Payroll Work Locations" ], "summary": "Retrieve PY Work Location By Codes", "description": "## Query Standards\n\n\n### Finder\n\nFollowing row finders are available for data filtering and optimizing request performance.\n\n- Find By Date\n- Primary Key\n \n\n#### Find By Date\n\nRecommended finder parameters. Refer to Query Parameters for example.\n\n| Parameter | Description | Sample |\n| --- | --- | --- |\n| auditDate | Create or Update Date Time Filter | 2022-12-20 |\n\n#### Primary Key\n\nThis is an optional finder for querying a specific Work Location Code by Primary Key (WrlCode)\n\n| Parameter | Description | Sample |\n| --- | --- | --- |\n| WrlCode | Work Location Code | YORK |", "parameters": [ { "name": "finder", "in": "query", "schema": { "type": "string" }, "example": "findByDate;auditDate=2015-01-01" }, { "name": "limit", "in": "query", "schema": { "type": "integer" }, "example": "500" }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "example": "0" }, { "name": "totalResults", "in": "query", "schema": { "type": "boolean" }, "example": "true" }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "example": "WrlCode:desc" } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourcecollection+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "example": { "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:02+00:00", "WrlSickPolicyCode": null, "WrlRegionCode": null, "WrlIuCreateDate": "2015-04-30T20:05:02+00:00", "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:06+00:00", "WrlSickPolicyCode": null, "WrlRegionCode": null, "WrlIuCreateDate": "2015-04-30T20:10:06+00:00", "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:37+00:00", "WrlSickPolicyCode": null, "WrlRegionCode": null, "WrlIuCreateDate": "2015-04-30T19:22:37+00:00", "WrlIuCreateUser": "ADWAIT", "WrlIuUpdateDate": "2016-10-26T17:30:57+00:00", "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:17+00:00", "WrlSickPolicyCode": null, "WrlRegionCode": null, "WrlIuCreateDate": "2015-04-30T19:23:17+00:00", "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:35+00:00", "WrlSickPolicyCode": null, "WrlRegionCode": null, "WrlIuCreateDate": "2015-04-30T19:16:35+00:00", "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" } ] } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````