ADP Time and Labor API

openapi: 3.0.1
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
info:
  contact:
    name: Vamshi Krishna Guduru
    email: VAMSHI.KRISHNA.GUDURU@ADP.COM
  description: <p>This API supports the processing of a collection data collection.</p><p><br></p><p>For more information
    please refer to - <a href="https://developers.adp.com/articles/guides/data-collection-entries-api-guide-for-workforce-now-tempus-pi">Data
    Collection Entries API Guide for Workforce Now Next Gen</a></p>
  title: Data Collection Entries
  version: 1.0.3
  x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/time/data-collection-entries/v1/data-collection-entries-swagger_v1-merged.json
  x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn)
  x-apievangelist-resource-path: time/data-collection-entries/v1/data-collection-entries
x-adpSpecData:
  domain: Time
  specId: 383982cd-18a0-466f-b6d9-5e4351649a25
  canonicalSpecId: f3d4813b-5953-4983-90a9-74879367deb3
  specStatusCode: publishing
  specTypeCode: REST
  specStateCode: active
  nonStandardIndicator: false
  visibilityCodes:
  - internal
  - external
  filename: data-collection-entries-swagger_v1-merged.json
  serviceProviderId: 'null'
  resourcePath: time/data-collection-entries/v1
  libraryVersion: ''
  businessRules:
  - 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: 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
  - 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: R3.5
    ruleTitle: A complete event has /data/eventContext and /data/output
    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: 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.2
    ruleTitle: An event notification does not include the transform or meta objects.
    visibilityCodes:
    - internal
  - 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: R8.1
    ruleTitle: An event notification includes the /data/eventContext and /data/output objects.
    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: 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: R6.1
    ruleTitle: An event instance which is being “worked on” has an event.status.code=inprogress
    visibilityCodes:
    - internal
  - rule: R2.3
    ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective
    visibilityCodes:
    - internal
  - rule: R3.3
    ruleTitle: /data/output communicates the result of the event instance.
    visibilityCodes:
    - internal
  - rule: R11.1
    ruleTitle: '''associateoid'' in the uri pattern should match the ''associateoid'' in the request header parameter'
    visibilityCodes:
    - internal
  - rule: R3.4
    ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results.
    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: 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: 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: 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: R1.0
    ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete
    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: 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: R6.2
    ruleTitle: An event instance which has been recorded has an event.status.code=complete
    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: R5.0
    ruleTitle: Meta returns the context rules for each data section
    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
  testCaseCollection:
    example:
      href: WFN_CG_Data_Collection_Entries.postman_collection.json
    description: Data Collection Entries Postman collection
  publicationContext:
    products:
    - productId: hcm-offrg-wfn
      productName: workforce now
      marketplaceProductName: ADP Workforce Now®
  specCategoryCode: ''
tags:
- name: Process Data Collection Entries
  description: This API supports the processing of a collection data collection entries from 1 to Many data collection terminals
    (i.e. Time Clock).
paths:
  /events/time/v1/data-collection-entries.process:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: dataCollectionTerminalManagement
      functionCode: dataCollectionManagement
      serviceCode: timeLaborManagement
      serviceCategoryCode: time
      canonicalName: Process Data Collection Entries
    post:
      summary: Process Data Collection Entries
      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:
        - MobilePSSDataCollection
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: time/timeLaborManagement/dataCollectionTerminalManagement/dataCollectionManagement/dataCollectionEntries.process
        operationCode: dataCollectionEntries.process
        operationId: ecc32a68-e5a2-4f73-9ff1-fdc567fc9e76
        roleCodes:
        - practitioner
        performAuthIndicator: true
        scenarios:
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 7 - Alternate WorkerID Sample - WorkassignmentID
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_7_-_Alternate_WorkerID_Sample_-_WorkassignmentID_Provide_Example_dataCollectionEntries.process_202_49656.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_7_-_Alternate_WorkerID_Sample_-_WorkassignmentID_Provide_Example_dataCollectionEntries.process_request_4830.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 6 - Alternate WorkerID Sample - AssociateOID
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_6_-_Alternate_WorkerID_Sample_-_AssociateOID_Provide_Example_dataCollectionEntries.process_202_49655.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_6_-_Alternate_WorkerID_Sample_-_AssociateOID_Provide_Example_dataCollectionEntries.process_request_4829.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 4 - Supervisor Edit
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_4_-_Supervisor_Edit_Provide_Example_dataCollectionEntries.process_202_49653.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_4_-_Supervisor_Edit_Provide_Example_dataCollectionEntries.process_request_4827.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 1 - Multiple Time Punch Entries
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_1_-_Multiple_Time_Punch_Entries_Provide_Example_dataCollectionEntries.process_202_49650.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_1_-_Multiple_Time_Punch_Entries_Provide_Example_dataCollectionEntries.process_request_4824.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 2 - IN Punch and OUT Punch Scan
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_2_-_IN_Punch_and_OUT_Punch_Scan_Provide_Example_dataCollectionEntries.process_202_49651.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_2_-_IN_Punch_and_OUT_Punch_Scan_Provide_Example_dataCollectionEntries.process_request_4825.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 5 - Alternate WorkerID Sample - PositionID
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_5_-_Alternate_WorkerID_Sample_-_PositionID_Provide_Example_dataCollectionEntries.process_202_49654.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_5_-_Alternate_WorkerID_Sample_-_PositionID_Provide_Example_dataCollectionEntries.process_request_4828.json
        - summary: Performing punches for Labour Allocation/Transfer
          name: Scenario 8 - Labour Allocation/Transfer
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_8_-_Labour_Allocation/Transfer_Custom_Example_dataCollectionEntries.process_202_495898.json
          description: Performing punches for Labour Allocation/Transfer
          content:
            application/json:
              externalValue: ./examples/Scenario_8_-_Labour_Allocation/Transfer_Custom_Example_dataCollectionEntries.process_request_46495.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Scenario 3 - Clock-in operaration
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '202'
            description: Accepted
            content:
              application/json:
                externalValue: ./examples/Scenario_3_-_Clock-in_operaration_Provide_Example_dataCollectionEntries.process_202_49652.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Scenario_3_-_Clock-in_operaration_Provide_Example_dataCollectionEntries.process_request_4826.json
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      requestBody:
        description: posted contents
        content:
          application/json:
            schema:
              $ref: ./schemas/events_time.dataCollectionEntries.process_schema_v01_00_rev002.json
        required: 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
                - external
              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: Process data collection entries event instance
          content:
            application/json:
              schema:
                $ref: ./schemas/events_time.dataCollectionEntries.process_schema_v01_00_rev002.json
        '202':
          $ref: '#/components/responses/202'
        '400':
          $ref: '#/components/responses/400'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        '403':
          $ref: '#/components/responses/403'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: Process data collection entries event instance
      operationId: ecc32a68-e5a2-4f73-9ff1-fdc567fc9e76
      parameters:
      - 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: 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: 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: ''
          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_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: 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: 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: SORUri
        description: Actual Uri within the SOR
        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: en-US
          type: string
        in: header
        name: Accept-Language
        description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that
          are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        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-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: 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: 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: 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: 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: 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: 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: 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: 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
      tags:
      - Process Data Collection Entries
  /events/time/v1/data-collection-entries.process/{event-id}:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: dataCollectionTerminalManagement
      functionCode: dataCollectionManagement
      serviceCode: timeLaborManagement
      serviceCategoryCode: time
      canonicalName: Process Data Collection Entries
    get:
      summary: Process Data Collection Entries  Event Instance (by Event Manager)
      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:
        - MobilePSSDataCollection
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: time/timeLaborManagement/dataCollectionTerminalManagement/dataCollectionManagement/dataCollectionEntries.process.read
        operationCode: dataCollectionEntries.process.read
        operationId: f87f7e5d-d646-4fe7-ba14-48f0b391cd25
        roleCodes:
        - practitioner
        performAuthIndicator: true
        scenarios:
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Data Collection Failure Conditions
          responses:
          - headers:
              ADP-Acting-Session-Expires: ''
              Cache-Control: ''
              sm_transactionid: ''
              ETag: ''
              ADP-Acting-SessionID: ''
              Content-Type: ''
            code: '202'
            description: This response indicates all the punch records in the payload completed, imported and posted successfully.
            content:
              application/json:
                externalValue: ./examples/Data_Collection_Failure_Conditions_Provide_Example_dataCollectionEntries.process.read_202_49657.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '207'
            description: This response occurs when some punch records fail to import or post to the timecard.
            content:
              application/json:
                externalValue: ./examples/Data_Collection_Failure_Conditions_Provide_Example_dataCollectionEntries.process.read_207_49658.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: This response occurs when all the punches failed to import or post to the timecard.
            content:
              application/json:
                externalValue: ./examples/Data_Collection_Failure_Conditions_Provide_Example_dataCollectionEntries.process.read_400_49659.json
          - code: '404'
            description: This response occurs when the requested upload event is not found in the database.
            content:
              application/json:
                externalValue: ./examples/Data_Collection_Failure_Conditions_Provide_Example_dataCollectionEntries.process.read_404_49660.json
          description: New description scenario for the consumer of this API to better understand this example.
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      responses:
        '200':
          headers:
            ADP-Acting-Session-Expires:
              schema:
                type: string
              description: Specifies the date and time the representati

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adp/refs/heads/main/openapi/adp-time-data-collection-entries-v1-openapi.yml