openapi: 3.2.0 info: contact: name: Vamshi Krishna Guduru email: VAMSHI.KRISHNA.GUDURU@ADP.COM description: WFN custom codelists. Please note, that 'Custom' denotes the SOR specific content, rather than a custom structure. The codelist schemas (v3 - legacy and v4 - nextgen) are shared across all standard and custom codelists. title: WFN Custom Codelists Worker Management Codelists API version: 3.0.0 x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/hcm/wfn-codelists/v3/wfn-codelists-swagger_v1-merged.json x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn) x-apievangelist-resource-path: hcm/wfn-codelists/v3/wfn-codelists servers: - url: https://api.adp.com description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens' - url: https://api.eu.adp.com description: ADP European API gateway - url: https://uat-api.adp.com description: ADP UAT / sandbox gateway tags: - name: Worker Management Codelists description: Custom codelists applicable to the WFN APIs across worker management features paths: /codelists/hr/v4/worker-management/{code-type}/wfn/{version-id}: x-adpPathData: uriTranslationIndicator: false featureCode: workerManagement functionCode: codeListViewing serviceCode: workerInformationManagement serviceCategoryCode: hr canonicalName: WFN Worker Management Codelists get: summary: Worker Management Codelists x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobilePSSWorkerProfile - MobileADMWorkerProfile - MobileESSWorkerProfile - MobileMSSWorkerProfile sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: hr/workerInformationManagement/workerManagement/codeListViewing/codelist.read operationCode: codelist.read operationId: c074ccbd-b37a-4e0e-afc4-cf9d54502f7d roleCodes: - practitioner - administrator - employee - manager performAuthIndicator: true scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: 1. List of Job Function codes responses: - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of State/Province/Territory values. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263546.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Job Function codes content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263545.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: 'Retrieves list of marital statuses for the specified country code.' content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263569.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Status Change Reasons. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263565.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: 'List of Marital Statuses. When no country code is passed it is pulling the list from Validation Tables > Personal Information > Marital Status. This list does not have any country parameter and is the full list of codes in the ADP Workforce Now client. This is the reason category is blank.' content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263568.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Language. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263558.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Worker Categories. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263563.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Chinese ethnic group Codes. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263567.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the E-Verify Work Locations. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263562.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Workers Compensation Statuses. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263548.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the management of the onboarding experience. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263561.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Status Change Reasons for given category. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263566.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the list of countries. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263564.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Workers Compensation Types. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263549.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of State/Province/Territory values based on country code content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263547.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the EEO Establishments. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263559.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Workers Compensation Class Code Type code List. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263551.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the NAICS Workers' Comp. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263560.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: Specifies the Workers compensation Job class code. content: application/json: externalValue: ./examples/1._List_of_Job_Function_codes_Custom_Example_codelist.read_200_263550.json description: New description scenario for the consumer of this API to better understand this example. visibilityCodes: - internal globalViewDevPortalIndicator: false responses: '200': headers: Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Request the list of all available worker management codes that the requester is authorized to view content: application/json: schema: $ref: ../../../common/shared/code-list-schema_v04.json '400': $ref: '#/components/responses/400' '412': $ref: '#/components/responses/412' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '304': $ref: '#/components/responses/304' '403': $ref: '#/components/responses/403' '503': $ref: '#/components/responses/503' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Request the list of all available codes based on the {code-type} value that are possible duirng the worker management in WFN operationId: c074ccbd-b37a-4e0e-afc4-cf9d54502f7d parameters: - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: path name: code-type description: The type of the associated codelist x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: path name: version-id description: The version of the associated codelist x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to. Typically injected by the API proxy, with few exceptions, e.g. callback scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: G4O73G9Z62SL2NFM type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal required: true tags: - Worker Management Codelists /codelists/hr/v3/worker-management/{code-type}/WFN/{version-id}: x-adpPathData: uriTranslationIndicator: false featureCode: workerManagement functionCode: codeListViewing serviceCode: workerInformationManagement serviceCategoryCode: hr canonicalName: WFN Worker Management Codelists get: summary: Worker Management Codelists x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobileESSWorkerProfile - MobilePSSWorkerProfile - MobileADMWorkerProfile - MobileMSSWorkerProfile sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: hr/workerInformationManagement/workerManagement/codeListViewing/codelist.read operationCode: codelist.read operationId: 60f7e727-3af8-4910-89e9-c4735eef9289 roleCodes: - employee - practitioner - administrator - manager performAuthIndicator: true scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: Worker Management V3 Code Lists responses: - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Cost Numbers for specified company codes. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263578.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Union Locals. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263572.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Cost Numbers. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263577.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Job Titles content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263573.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Pay Grades. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263580.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Union Codes content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263571.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Business Units. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263570.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Departments. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263575.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Locations. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263574.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Eligibility Classes. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263579.json - headers: Cache-Control: unset ETag: unset Content-Type: unset code: '200' description: List of Departments for specified company codes. content: application/json: externalValue: ./examples/Worker_Management_V3_Code_Lists_Custom_Example_codelist.read_200_263576.json description: New description scenario for the consumer of this API to better understand this example. visibilityCodes: - internal globalViewDevPortalIndicator: false responses: '200': headers: Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Request the list of all available worker management codes that the requester is authorized to view content: application/json: schema: $ref: ../../../common/shared/code-list-schema_v03.json '400': $ref: '#/components/responses/400' '412': $ref: '#/components/responses/412' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '403': $ref: '#/components/responses/403' '304': $ref: '#/components/responses/304' '503': $ref: '#/components/responses/503' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Request the list of all available codes based on the {code-type} value that are possible duirng the worker management in WFN operationId: 60f7e727-3af8-4910-89e9-c4735eef9289 parameters: - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: path name: code-type description: The type of the associated codelist x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: path name: version-id description: The version of the associated codelist x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to. Typically injected by the API proxy, with few exceptions, e.g. callback scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: G4O73G9Z62SL2NFM type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal required: true tags: - Worker Management Codelists components: responses: '429': description: Too Many Requests content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '406': description: Not Acceptable content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '403': description: Forbidden content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '405': description: Method Not Allowed content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '500': description: Internal Server Error content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '404': description: Not Found content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '304': description: Not Modified '400': headers: Content-Language: schema: type: string x-adpParameterData: visibilityCodes: - internal required: false Last-Modified: schema: type: string x-adpParameterData: visibilityCodes: - internal required: false description: Bad Request content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '503': description: Service Unavailable content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '412': description: Precondition Failed content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json '413': description: Request Entity Too Large content: application/json: schema: $ref: ../../../common/shared/confirm-message-schema_v03.json x-adpSpecData: domain: HCM specId: 864ade6d-103f-438c-806c-cecf5f5e8bf4 canonicalSpecId: 6b80d349-f5c3-4603-ab97-d2b98060a15e specStatusCode: publishing specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: wfn-codelists-swagger_v1-merged.json serviceProviderId: WFN resourcePath: hcm/sor-codelists/v1 libraryVersion: '' testCaseCollection: example: href: WFN_CG_Custom_Codelists.postman_collection.json description: ' WFN Custom Codelists Postman Collection' publicationContext: products: - productId: hcm-offrg-wfn productName: workforce now marketplaceProductName: ADP Workforce Now® specCategoryCode: ''