Page Comparison

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: DRAFTGetRoles_GetRolesv1.xlsx

Endpoints:

Dev (Less stable (ongoing build process), can use for failure testing, or getting queries correct):

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles

Test (Preferred Endpoint, more stable):

https://gw-tst.its.yale.edu/soa-gateway/COAHub/v1/GetRoles

Production (Not Available until Workday R4 Go-Live July 1 2017):

https://gw.its.yale.edu/soa-gateway/COAHub/v1/GetRoles

Endpoint:

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 valueRole 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:

outputformat=json

...

Examples:

Batch for Cost Center (limit by org type)-

...

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

...

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

...

Example XML:

<Roles>

   <Header>
 
      <Version>1.0</Version>
        <Count>1<<Count>134</Count>

   </Header>

   <Role>
        <Cd>SO100113<<Cd>CC0501</Cd>
      <Nm>FASPHY Physics <Nm>Department of Applied Physics<Research Unit</Nm>
 
      <Inactive>0</Inactive>
        <Type>SUPERVISORY<<Type>COST_CENTER</Type>
        <RoleID>business_partner<<RoleID>Cost_Center_Financial_Analyst</RoleID>
      <RoleNm>Cost Center <RoleNm>BusinessFinancial Partner<Analyst</RoleNm>
        <WorkerNm>Wojciechowski<WorkerNm>Fagan, MelissaPauline A</WorkerNm>
      <EmpID>4504</EmpID>
    <EmpID>81827</EmpID>  <NETID>pfagan</NETID>
      <NETID>mac247<<UPI>10075276</NETID>UPI>
        <UPI>12051628</UPI>
<Email>pauline.fagan@yale.edu</Email>
      <LoadDt>2017-05-18</LoadDt>
   </Role>
</Roles>

Example JSON:

{
  "Roles": {
    "Header": {
      "Count": "1",
      "Version": "1.0"
    },
    "Role": {
            "RoleNm": "Business Partner",
            "Nm": "Department of Applied Physics",
            "NETID": "mac247",
            "Email": "melissa.wojciechowski@yale.edu",
            "EmpID": "81827",
            "Type": "SUPERVISORY",
            "Inactive": "0",
            "Cd": "SO100113",
            "LoadDt": "2017-05-18",
            "UPI": "12051628",
            "RoleID": "business_partner",
            "WorkerNm": "Wojciechowski, Melissa A"
    }
  }
}

...