Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Data Source:  Workday (roles) /COAHub / People Hub (identifiers/name)

This service will query for an organization or multiple organizations and provide you with the roles associated. The XML/JSON response will be by person, not by role or org. For each distinct role+employee match, there will be 1 <Role> loop. For example, employee 10780 has 3 roles in the same Cost Center, so he will come as 3 <Role> nodes, 1 for each role he has.

To Request Access: Request access to COA Validator/Segment Service/COA Integration Hub (includes Roles)


GetRoles Service Contract: GetRoles_v1.xlsx

...

Parameters: These can be added in any amount, all can be used, just one, or any combination of them. However, at least 1 required parameter value must be used for this service. To use multiple parameters place "&" in between the parameter names. If you You are restricted to which Roles you may see you must pass one of the "Role" value. If you are restricted to a role type Ex. SUPERVISORY, you must pass type value.Role parameter values.

You are required to enter one of these parameters:

Option A:

typerole=   (Ex. Cost _ Center , SupervisoryManager)

Option B:

coderoleid= (Ex.  CC0001)

Option C:

role= cost_center_manager)

You are may optionally enter any of these parameters:

Netid=

UPI=

type=  (Ex. Cost_Center Manager, Supervisory)

Option D: Limiting Parameters (You should send these along with the role name for the best response):

Netid=

UPI=

code= (Ex. CC0001)

You may send this parameter with any set of options to receive the response in json instead of XML:

...

Examples:

Batch for Cost Center (limit by org type)-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?Type=SUPERVISORY

Batch for Cost Center Manager (limit by role)-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?type=COST_CENTER&role=Cost Center Manager

Batch for Supervisory in JSON-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?type=SUPERVISORY&outputformat=json

One Supervisory Org-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?code=SO100113

...