Retrieve a single job application.
The itemID the response is referred to as the job application-id. This id can be used as an input to the Job Applications V2 API to retrieve information for a single job application.
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development. For more information, see API Common Exceptions and Tips for Handling.
' name: Retrieve a single job application. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Returns a single job application. content: application/json: externalValue: ./examples/Retrieve_a_single_job_application._Provide_Example_jobApplication.read_200_44151.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '500' description: Returns when clientRequisitionID is sent in single or double quotes using filter. content: application/json: externalValue: ./examples/Retrieve_a_single_job_application._Provide_Example_jobApplication.read_500_44156.json description: 'Retrieve a single job application.
The itemID the response is referred to as the job application-id. This id can be used as an input to the Job Applications V2 API to retrieve information for a single job application.
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development. For more information, see API Common Exceptions and Tips for Handling.
' visibilityCodes: - internal - external globalViewDevPortalIndicator: true responses: '200': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Returns a job application content: application/json: schema: $ref: ./schemas/jobApplications_schema_v02_00_rev010.json '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '412': $ref: '#/components/responses/412' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '204': $ref: '#/components/responses/204' '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' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' operationId: ab513f15-9bdb-4991-ad9d-c6a32b557dfb description: Returns a job application parameters: - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ConsumerAppOID description: Identifier for the service consumer application. This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - 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: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-AssociateOID description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_serversessionid description: 'SiteMinder session ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA=' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $expand description: The OData $expand parameter MUST be used to specify the expansion criteria. Please refer "RESTful Web API Design Standard" for more details x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry 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: AP1234567890 type: string in: path name: job-application-id description: Job Application ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry 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: '' 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 - external required: false - schema: default: '' type: string in: header name: ADP-Acting-SessionID description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false - 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: 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 - external 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 tags: - Job Applications /staffing/v2/job-applications: x-adpPathData: uriTranslationIndicator: false featureCode: positionSeekerManagement functionCode: applicantManagement serviceCode: staffingManagement serviceCategoryCode: staffing canonicalName: Job Applications get: summary: Job Applications 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: - MobileESSStaffing - MobilePSSStaffing - MobileMSSStaffing canonicalUri: staffing/staffingManagement/positionSeekerManagement/applicantManagement/jobApplication.read sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationCode: jobApplication.read operationId: fa2ab202-5c9f-4587-8901-cb926f3b2324 roleCodes: - employee - practitioner - manager performAuthIndicator: true scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: 9. When an invalid clientRequisitionID is passed responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: Bad Request content: application/json: externalValue: ./examples/9._When_an_invalid_clientRequisitionID_is_passed_Custom_Example_jobApplication.read_400_602136.json description: New description scenario for the consumer of this API to better understand this example. - summary:This use case retrieves all job applications, or a single job application open for internal and external hiring. This is for a specific job requisition created by a Hiring Manager.
The itemID in the response is referred to as the Job Application ID. This can be used as an input to the Job Applications V2 API to retrieve information for a single job application.
name: 2. Returning a job application for a client requisition ID responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: 'Request the list of all available job applications that the requester is authorized to view. Here filter used is /staffing/v2/job-applications?$filter=jobRequisitionReference/clientRequisitionID eq 1010' content: application/json: externalValue: ./examples/2._Returning_a_job_application_for_a_client_requisition_ID_Custom_Example_jobApplication.read_200_602128.json description:This use case retrieves all job applications, or a single job application open for internal and external hiring. This is for a specific job requisition created by a Hiring Manager.
The itemID in the response is referred to as the Job Application ID. This can be used as an input to the Job Applications V2 API to retrieve information for a single job application.
- summary: New description scenario for the consumer of this API to better understand this example. name: 10. When the requisitionTitle is invalid responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: Bad Request content: application/json: externalValue: ./examples/10._When_the_requisitionTitle_is_invalid_Custom_Example_jobApplication.read_400_602137.json description: New description scenario for the consumer of this API to better understand this example. - summary: Returns a job application for an application status using filter name: 6. Returning a job application for an application status responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: 'Request the list of all available job applications that the requester is authorized to view Here filter used is $filter=applicationStatusCode/codeValue eq Make Offer' content: application/json: externalValue: ./examples/6._Returning_a_job_application_for_an_application_status_Custom_Example_jobApplication.read_200_602132.json description: Returns a job application for an application status using filter - summary: Returns all job applications using the top and skip filters name: 8. Returning all job applications using the top and skip filters responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Request the list of all available job applications that the requester is authorized to view content: application/json: externalValue: ./examples/8._Returning_all_job_applications_using_the_top_and_skip_filters_Custom_Example_jobApplication.read_200_602134.json description: Returns all job applications using the top and skip filters - summary: Returns a job application for an application type using filter name: 7. Returning a job application for an application type responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: 'Request the list of all available job applications that the requester is authorized to view. Here filter used is $filter=applicant/internalApplicantIndicator eq false' content: application/json: externalValue: ./examples/7._Returning_a_job_application_for_an_application_type_Custom_Example_jobApplication.read_200_602133.json description: Returns a job application for an application type using filter - summary: Returns a job application for an applied date using filter name: 5. Returning a job application for an applied date responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: 'Request the list of all available job applications that the requester is authorized to view Here filter used is $filter=applicationSource/submittedDate eq 2019-08-16' content: application/json: externalValue: ./examples/5._Returning_a_job_application_for_an_applied_date_Custom_Example_jobApplication.read_200_602131.json description: Returns a job application for an applied date using filter - summary: Returns a job application for a requisition title when we use filter name: 3. Returning a job application for a requisition title responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: 'Request the list of all available job applications that the requester is authorized to view. here filter used is $filter=jobRequisitionReference/requisitionTitle eq OT' content: application/json: externalValue: ./examples/3._Returning_a_job_application_for_a_requisition_title_Custom_Example_jobApplication.read_200_602129.json description: Returns a job application for a requisition title when we use filter - summary: New description scenario for the consumer of this API to better understand this example. name: 11. When the submittedDate is sent in an invalid format responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: Bad Request content: application/json: externalValue: ./examples/11._When_the_submittedDate_is_sent_in_an_invalid_format_Custom_Example_jobApplication.read_400_602138.json description: New description scenario for the consumer of this API to better understand this example. - summary: Returns job applications for an applied job location using filter name: 4. Returning job applications for an applied job location responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: 'Request the list of all available job applications that the requester is authorized to view. Here filter used is $filter=appliedLocations/itemID eq 169734009081_1' content: application/json: externalValue: ./examples/4._Returning_job_applications_for_an_applied_job_location_Custom_Example_jobApplication.read_200_602130.json description: Returns job applications for an applied job location using filter - summary: New description scenario for the consumer of this API to better understand this example. name: 12. when clientRequisitionID is sent in single or double quotes using filter responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '500' description: 'Internal Server Error "userMessage": {"messageTxt": "Label not found, missing following key: Exception in the requestWFN-REC-MarketPlace-API getPaginated Applications() - Exception "}' content: application/json: externalValue: ./examples/12._when_clientRequisitionID_is_sent_in_single_or_double_quotes_using_filter_Custom_Example_jobApplication.read_500_602139.json description: New description scenario for the consumer of this API to better understand this example. - summary: 'Retrieves all job applications.
Supported OData Query Options
This use case supports Query String Options as defined by Open Data Protocol (OData).
For more information about OData, see Introduction to the ADP API Open Data (OData) Protocol.
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development. For more information, see API Common Exceptions and Tips for Handling.
' name: Retrieves all the job applications. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Request the list of all available job applications that the requester is authorized to view content: application/json: externalValue: ./examples/Retrieves_all_the_job_applications._Provide_Example_jobApplication.read_200_44138.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: Returns when the submittedDate is sent in an invalid format. content: application/json: externalValue: ./examples/Retrieves_all_the_job_applications._Provide_Example_jobApplication.read_400_44140.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: Returns when the filter is invalid. content: application/json: externalValue: ./examples/Retrieves_all_the_job_applications._Provide_Example_jobApplication.read_400_44139.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '500' description: 'Returns when the clientRequisitionID is sent in single or double quotes using filter $filter=job Requisition Reference/clientRequisitionID eq "1010"' content: application/json: externalValue: ./examples/Retrieves_all_the_job_applications._Provide_Example_jobApplication.read_500_44141.json description: 'Retrieves all job applications.
Supported OData Query Options
This use case supports Query String Options as defined by Open Data Protocol (OData).
For more information about OData, see Introduction to the ADP API Open Data (OData) Protocol.
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development. For more information, see API Common Exceptions and Tips for Handling.
' visibilityCodes: - internal - external globalViewDevPortalIndicator: true responses: '200': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Request the list of all available job applications that the requester is authorized to view content: application/json: schema: $ref: ./schemas/jobApplications_schema_v02_00_rev010.json '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' '412': $ref: '#/components/responses/412' '401': $ref: '#/components/responses/401' '413': $ref: '#/components/responses/413' '204': $ref: '#/components/responses/204' '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' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' operationId: fa2ab202-5c9f-4587-8901-cb926f3b2324 description: Request the list of all available job applications that the requester is authorized to view parameters: - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ConsumerAppOID description: Identifier for the service consumer application. This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $filter description: The OData $filter parameter MUST be used to specify the filter criteria. The usage sample is below. Various criteria could be combined using and/or operands and () to set the operand precedence. Please refer "RESTful Web API Design Standard" for more details x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - 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: '' type: string in: header name: sm_serversessionid description: 'SiteMinder session ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA=' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' 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: '' type: string in: header name: ADP-Acting-SessionID description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Managed-OrgOID description: The organization whose data is being managed x-adpParameterData: visibilityCodes: - internal - external required: false - 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 - external required: true - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI 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: SOR description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: query name: $select description: The OData $select parameter MUST be used to specify the selection criterion Certain implemetations may return an error if $select parameter is omitted. Please refer RESTful Web API Design Standard document for this query parameter specification details. x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-AssociateOID description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $expand description: The OData $expand parameter MUST be used to specify the expansion criteria. Please refer "RESTful Web API Design Standard" for more details x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry 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 - external required: false - 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 tags: - Job Applications components: responses: '429': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Too Many Requests content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '406': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Not Acceptable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '403': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Forbidden content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '401': description: Unauthorized content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '405': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Method Not Allowed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '204': description: No content content: application/json: {} '500': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Internal Server Error content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '404': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Not Found content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '304': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Not Modified '400': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Bad Request content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '503': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Service Unavailable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '412': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Precondition Failed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '504': description: Gateway Timeout content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '413': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false 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 - external 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 - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios 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 - external required: false description: Request Entity Too Large content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json x-adpSpecData: domain: Staffing specId: 9a45d7fb-6303-4fbc-98e0-24d161a06a99 canonicalSpecId: 5376b578-acd8-4b8a-81ff-52a5a0838a2a specStatusCode: publishing specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: job-applications-swagger_v2-merged.json serviceProviderId: ADPRECRUIT resourcePath: staffing/job-applications/v2 libraryVersion: '' businessRules: - rule: R3.2 ruleTitle: /data/transform is only used during the recording of the event. The transform is the data that is provided by a user/machine to complete the recording of the event. visibilityCodes: - internal - rule: R5.1 ruleTitle: The only information that must be valued in the meta for the events header are the standard codelist references for priorityCode, eventStatusCode, and serviceCategoryCode visibilityCodes: - internal - rule: R8.1 ruleTitle: An event notification includes the /data/eventContext and /data/output objects. visibilityCodes: - internal - rule: R6.2 ruleTitle: An event instance which has been recorded has an event.status.code=complete visibilityCodes: - internal - rule: R3.4 ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results. visibilityCodes: - internal - rule: R6.1 ruleTitle: An event instance which is being “worked on” has an event.status.code=inprogress visibilityCodes: - internal - rule: R5.0 ruleTitle: Meta returns the context rules for each data section visibilityCodes: - internal - rule: R6.0 ruleTitle: An event instance may be created by a System of record for a user to complete. This event instance will have a event.status.code=created visibilityCodes: - internal - rule: R4.0 ruleTitle: All envelope data is set by the System of Record (e.g. event.ID, creationDateTime, recordDateTime, event.status.code, etc… visibilityCodes: - internal - rule: R3.0 ruleTitle: /data/schemaContext communicates the keys and properties that relate the event instance to a concrete concept (e.g. associate). visibilityCodes: - internal - rule: R2.3 ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective visibilityCodes: - internal - rule: R3.5 ruleTitle: A complete event has /data/eventContext and /data/output visibilityCodes: - internal - rule: R3.6 ruleTitle: An event which is being recorded includes the /data/eventContext and the /data/transform during the composition phase (i.e. recording of the event). visibilityCodes: - internal - rule: R2.1 ruleTitle: If the event is declared by an actor then the creationDateTime is the date time when the first call is made to the System of Record. visibilityCodes: - internal - rule: R1.0 ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete visibilityCodes: - internal - rule: R2.2 ruleTitle: The recordDateTime is the date time which the event is recorded in the system of record with an event.status.code=complete visibilityCodes: - internal - rule: R3.1 ruleTitle: /data/input is optional. Input communicates data that is needed to complete recording the event instance. An example is a benefits.enroll event. The input communicates the benefitOfferings (the choices) that the user has to make which are communicated in the transform. visibilityCodes: - internal - rule: R0.2 ruleTitle: If request contains ADP-On-Behalf-Of-OrgOID, ADP-On-Behalf-Of-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-On-Behalf-Of-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data. visibilityCodes: - internal - rule: R8.2 ruleTitle: An event notification does not include the transform or meta objects. visibilityCodes: - internal - rule: US Person Birth Year ruleTitle: '**Masking [Pattern:](/library/patterns/#revealmasked)** XXXX-01-15 (mask year) **Reveal Operation Canonical ID: ** /core/accessManagement/sensitiveDataManagement/birthDateManagement/usBirthDateYear.reveal' visibilityCodes: - internal - rule: R0.1 ruleTitle: If request contains ADP-Act-As-OrgOID, ADP-Act-As-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-Act-As-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data. visibilityCodes: - internal - rule: R2.4 ruleTitle: If there is no effective date from a business perspective then the effective date should be set equal to the record date time. visibilityCodes: - internal - rule: R0.3 ruleTitle: 'For Act-As or On-Behalf-Of requests, header ''Cache-Control: no-store'' MUST be set to indicate on server or on UI the response object SHOULD not be cached' visibilityCodes: - internal - rule: R3.3 ruleTitle: /data/output communicates the result of the event instance. visibilityCodes: - internal - rule: R15.1 ruleTitle: 'An SOR may return an HTTP 503 when they are down for a scheduled maintenance or for an outage.If an SOR is planning a maintenance window then they should plan on having an end point available to return the 503 with a standard confirmMessage. The confirmMessage will contain a message stating the date and timeframe that the maintenance window is for.The SOR should return the Retry-After response-header field with the Date and Time when they expect the system to be available. E.g. § Retry-After: Fri, 31 Dec 1999 23:59:59 GMT This does not need to be handled dynamically. They can set the time that their maintenance window ends.' visibilityCodes: - internal - rule: R8.3 ruleTitle: 'A self link is included in the /data/links with 1 links item with the following 2 properties: rel=”self” href=”/events-notifications/{domain}/v1/{event-name}/{eventID}”' visibilityCodes: - internal - rule: R2.0 ruleTitle: creationDateTime is the date that the event is created. If a System of Record creates the event instance then it sets the creationDateTime. visibilityCodes: - internal eventNotifications: - eventCode: jobApplication.status.change.eventNotify.subscribe example: href: JobApplicationStatusChange_EventNotification_WFN.json testCaseCollection: example: href: WFN_CG_Job_applications.postman_collection.json description: WFN_CG_Job_applications.postman_collection publicationContext: products: - productId: hcm-offrg-wfn productName: workforce now marketplaceProductName: ADP Workforce Now® specCategoryCode: ''