Page Comparison

...

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. In order to use "roles" you must use it with an identifier parameter, like name. 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 a set one of these parameters:

Option A:

type=  (Ex. Cost_Center, Supervisory)

page=  (The response will be paginated, this must be used with batches, you will get the totalpages in the response so you know how many times to loop)

recordsperpage= (the quantity of records you want in each page, the options are 1-999)

Option B:

code= (Ex. CC0001)

You are not required to enter this parameter, but can with option A or B above in order to limit your response to one role:

...

Option B:

code= (Ex. CC0001)

Option C:

role= (Ex. Cost Center Manager)

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

...

Batch for Cost Center (limit by org type)-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?type=COST_CENTER&page=1&recordsperpage=10Type=SUPERVISORY

Batch for Cost Center P2P Approver Manager (limit by type and role)-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?type=COST_CENTER&page=1&recordsperpage=10&role=Cost Center P2P Unlimited ApproverManager

Batch for Supervisory in JSON-

https://gw-dev.its.yale.edu/soa-gateway/COAHub/v1/GetRoles?type=SUPERVISORY&page=1&recordsperpage=10&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=HR 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

Example XML:

<Roles xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wd="urn:com.workday/bsvc">
   <Header><Roles>
    <Header>
        <Page>1</Page><Version>1.0</Version>
        <TotalPages>164<<Count>1</TotalPages>Count>
    </Header>
    <Role>
      <Cd>CC0001<  <Cd>SO100113</Cd>
        <Nm>Department <Nm>HOSBUSof BusinessApplied Office<Physics</Nm>
        <Inactive>0</Inactive>
      <Type>COST_CENTER<  <Type>SUPERVISORY</Type>
        <RoleID>Cost_Center_Financial_Analyst<<RoleID>business_partner</RoleID>
      <RoleNm>Cost Center Financial<RoleNm>Business Analyst<Partner</RoleNm>
      <WorkerNm>Gagliardi  <WorkerNm>Wojciechowski, AnthonyMelissa Dai<A</WorkerNm>
      <EmpID>151677<  <EmpID>81827</EmpID>
        <NETID>mac247</NETID>
        <UPI>12051628</UPI>
    </Role>
</Roles>

Example JSON:

{
  "Roles": {
    "Header":    {
      "PageCount": "1",
      "TotalPagesVersion": "4251.0"
    },
    "Role":    [
            {

        "RoleNm": "HRBusiness Partner",
         "Nm": "Department of Applied Physics",
      "NETID": "mac247",
      "EmpID": "15409781827",
         "Type": "SUPERVISORY",
         "Inactive": "0",
         "Cd": "SO100113",
      "UPI": "12051628",
      "RoleID": "HRbusiness_Partnerpartner",
         "WorkerNm": "HuberWojciechowski, KyleenMelissa A"
    }
  }
}