Common API Operations for RUN Powered by ADP
Jump to chapter:

Data Dictionary for Operation Common Resources

The RUN Powered by ADP APIs follow a common design pattern to payload schemas. The following information provides you the list of common resources included in all RUN Powered by ADP APIs. In addition, each API has resources that are specific to the APIs covered in the various API guides.

Add Operation Request Payload

Resource Location

Description

Sample

/events/data/eventContext

Specifies the data which sets the context for the event. That is, the keys which set context.

{"events": [{"data": {"eventContext": {}}}]}.

/events/data/eventContext/ worker/associateOID

Specifies data for the worker associate ID.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}}}}]}

/events/data/transform

Specifies the JavaScript Object Notation (JSON) object which holds the information to which the worker is adding, updating, or removing.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}},"transform": {"worker": {"businessCommunication": {"email": {"emailUri": ""}}}}}}]}

/events/actor/associateOID

Specifies the unique identifier of an associate who originated the event.

{"events": [{ "actor": {"associateOID": ""}}]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{ "serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email.add or worker.hire.

{"events": [{ "eventNameCode": {"codeValue": "worker.personalCommunication.email.add"}}]}

Add Operation Response Payload

Resource Location

Description

Sample

/events/data/output

Specifies the result of the Event.

{"events":[{"data":{"output":{ "worker":{ "businessCommunication": {"email":{"emailUri":""}}}}, "eventContext":{"worker": {"associateOID":""}}}, "eventStatusCode": {"codeValue":"complete", "shortName":"complete"}}]}

/events/data/output/eventStatusCode/

Identifies the status of the event.
created - An event that has been initiated by the system of record (SOR).
inProgress - An event that is saved in a work in progress state.
complete - An event that has been recorded.
These values are set by the SOR and valued based on a standard codeslist.

{"events": [{"data": {"output": { "eventStatusCode": {"codeValue": "complete"}}}}]}

/events/eventID/

Specifies the unique identifier of the event instance. This is set by the SOR after an event is recorded as inProgress or complete.

{"events": [{"eventID": "a429ae7d-c8bb-45f4-8951-67b91c5446e7" }]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{"serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email.add or worker.hire.

{"events": [{"eventNameCode": {"codeValue": "worker.personalCommunication.email.add"}}]}

/events/creationDateTime/

Specifies the date time the event is created.

{"events": [{"creationDateTime": ""}]}

/events/recordDateTime/

Specifies the date time the event is recorded in the SOR with an event status code equal to complete.

{"events": [{"recordDateTime": ""}]}

/events/originator/

Specifies a user, machine, or event that triggered the event.

{"events": [{"originator": { }}]}

/events/originator/associateOID/

Specifies the unique identifier of an associate who originated the event.

{"events": [{"originator": {"associateOID": ""}}]}

Change Operation Request Payload

Resource Location

Description

Sample

/events/data/eventContext

Specifies the data which sets the context for the event. That is, the keys which set context.

{"events": [{"data": {"eventContext": {}}}]}

/events/data/eventContext/worker/ associateOID

Specifies the data for the worker associate ID.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}}}}]}

/events/data/transform

Specifies the JSON object which holds the information to which the worker is adding, updating, or removing.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}},"transform": {"worker": {"businessCommunication": {"email": {"emailUri": ""}}}}}}]}

/events/actor/associateOID

Specifies the unique identifier of an associate who originated the event.

{"events": [{ "actor": {"associateOID": ""}}]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{ "serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email. change.

{"events": [{ "eventNameCode": {"codeValue": "worker.personalCommunication. email.change"}}]}

Change Operation Response Payload

Resource Location

Description

Sample

/events/data/output

Specifies the result of the Event.

{"events": [{"eventStatusCode": {"codeValue": "complete","shortName": "complete"},"data": {"eventContext": {"worker": {"associateOID": ""}},"output": {"worker": {"businessCommunication": {"email": {"emailUri": ""}}}}}}]}

/events/data/output/eventStatusCode/ 

Identifies the status of the event.
created - An event that has been initiated by the SOR.
inProgress - An event that is saved in a work in progress state.
complete - An event that has been recorded.
These values are set by the SOR and valued based on a standard codeslist.

{"events": [{"data": {"output": { "eventStatusCode": {"codeValue": "complete"}}}}]}

/events/eventID/

Specifies the unique identifier of the event instance. This is set by the SOR after an event is recorded as inProgress or complete.

{"events": [{"eventID": "a429ae7d-c8bb-45f4-8951-67b91c5446e7" }]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{"serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email.change

{"events": [{"eventNameCode": {"codeValue": "worker.personalCommunication.email.change"}}]}

/events/creationDateTime/

Specifies the date time the event is created.

{"events": [{"creationDateTime": ""}]}

/events/recordDateTime/

Specifies the date time the event is recorded in the SOR with an event status code equal to complete.

{"events": [{"recordDateTime": ""}]}

/events/originator/

Specifies a user, machine, or event that triggered the event.

{"events": [{"originator": { }}]}

/events/originator/associateOID/

Specifies the unique identifier of an associate who originated the event.

{"events": [{"originator": {"associateOID": ""}}]}

Remove Operation Request Payload

Resource Location

Description

Sample

/events/data/eventContext

Specifies the data which sets the context for the event. That is, the keys which set context.

{"events": [{"data": {"eventContext": {}}}]}

/events/data/eventContext/worker/ associateOID

Specifies data for the worker associate ID.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}}}}]}

/events/data/transform

Specifies the JSON object which holds the information to which the worker is adding, updating, or removing.

{"events": [{"data": {"eventContext": {"worker": {"associateOID": ""}},"transform": {"worker": {"businessCommunication": {"email": {"emailUri": ""}}}}}}]}

/events/actor/associateOID

Specifies the unique identifier of an associate who originated the event.

{"events": [{ "actor": {"associateOID": ""}}]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{ "serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email. remove

{"events": [{ "eventNameCode": {"codeValue": "worker.personalCommunication.email.remove"}}]}

Remove Operation Response Payload

Resource Location

Description

Sample

/events/data/output

Specifies the result of the Event.

"events": [{"eventStatusCode": {"codeValue": "complete","shortName": "complete"},"data": {"eventContext": {"worker": {"associateOID": ""}},"output": {"worker": {"businessCommunication": {"email": {"emailUri": ""}}}}}}]}

/events/data/output/eventStatusCode/

Identifies the status of the event.
created - An event that has been initiated by the SOR.
inProgress - An event that is saved in a work in progress state.
complete - An event that has been recorded.
[These values are set by the SOR and valued based on a standard codeslist.

{"events": [{"data": {"output": { "eventStatusCode": {"codeValue": "complete"}}}}]}

/events/eventID/

Specifies the unique identifier of the event instance. This is set by the SOR after an event is recorded as inProgress or complete.

{"events": [{"eventID": "a429ae7d-c8bb-45f4-8951-67b91c5446e7" }]}

/events/serviceCategoryCode/

Specifies the service domain, such as HR, Payroll, Benefits, and so on.

{"events": [{"serviceCategoryCode": {"codeValue": "workerInformationManagement"}}]}

/events/eventNameCode/

Specifies the canonical name of the event, such as worker.personalCommunication.email. remove.

{"events": [{"eventNameCode": {"codeValue": "worker.personalCommunication.email.remove"}}]}

/events/creationDateTime/

Specifies the date time the event is created.

{"events": [{"creationDateTime": ""}]}

/events/recordDateTime/

Specifies the date time the event is recorded in the SOR with an event status code equal to complete.

Specifies the date time the event is recorded in the SOR with an event status code equal to complete.

/events/originator/

Specifies a user, machine, or event that triggered the event.

{"events": [{"originator": { }}]}

/events/originator/associateOID/

Specifies data for the worker associate ID.

{"events": [{"originator": {"associateOID": ""}}]}