Roles Service

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.

Service Contract: DRAFT_GetRoles.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 parameter value must be used for this service. To use multiple parameters place "&" in between the parameter names. If you are restricted to which Roles you may see you must pass the "Role" value. If you are restricted to a role type Ex. SUPERVISORY, you must pass type value.

You are required to enter one of these parameters:

Option A:

type= (Ex. Cost_Center, Supervisory)

Option B:

code= (Ex. CC0001)

Option C:

role= (Ex. Cost Center Manager)

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

Netid=

UPI=

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)-

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

One Supervisory with One Role-

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

One Cost Center in JSON-

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

One Supervisory Org with One Role in JSON-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?code=CC0119&outputformat=json&role=Cost Center Financial Analyst

Orgs for One person and One Role:

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

Example XML:

Example Response

<Roles>
    <Header>
        <Version>1.0</Version>
        <Count>1</Count>
    </Header>
    <Role>
        <Cd>SO100113</Cd>
        <Nm>Department of Applied Physics</Nm>
        <Inactive>0</Inactive>
        <Type>SUPERVISORY</Type>
        <RoleID>business_partner</RoleID>
        <RoleNm>Business Partner</RoleNm>
        <WorkerNm>Wojciechowski, Melissa A</WorkerNm>
        <EmpID>81827</EmpID>
        <NETID>mac247</NETID>
        <UPI>12051628</UPI>
    </Role>
</Roles>

Example JSON:

Example Response

{
  "Roles": {
    "Header": {
      "Count": "1",
      "Version": "1.0"
    },
    "Role": {
      "RoleNm": "Business Partner",
      "Nm": "Department of Applied Physics",
      "NETID": "mac247",
      "EmpID": "81827",
      "Type": "SUPERVISORY",
      "Inactive": "0",
      "Cd": "SO100113",
      "UPI": "12051628",
      "RoleID": "business_partner",
      "WorkerNm": "Wojciechowski, Melissa A"
    }
  }
}