HR Software Raw Data API Support

Raw Data
Home > Resources > Raw Data

The Raw Data API allows the user to retrieve mulitple data sets for mulitple employees rather than individual data sets utilized in the rest of the APIs.

Available datasets are specified using the "include" query parameter as a comma-delimited list (e.g. /rawdata?include=employee,job,compensation,changes). These data sets return the same information as returned by Employee, Job, Compensation, and Changes APIs.

Resource URL

https://serverurl/path/v1.1/rawdata
.

Example Request
GET	https://serverurl/api/v1.1/rawdata?include=employee,job,compensation,changs&changesince=1/1/2012

Request Content

Parameters are the same as the Employee Finder API. In addition, this API offers:

Changesince (id or date)
Changefields (comma delimited)
Changeactions (comma delimited)

Changesince is required.

Return Value

Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned.

XML

<rawdata>
  <data>
    <employee>
      <uid>26</uid>
      <firstName>Tanisha</firstName>
      <lastName>Jones</lastName>
      <middleName />
      <ssn>458-78-5897</ssn>
      <employeeID>20199</employeeID>
      <birthDate>1971-05-24T00:00:00</birthDate>
      <gender>F</gender>
      <contact>
        <country>USA</country>
        <address1>120 1st Ave</address1>
        <address2>Apt #1101</address2>
        <city>Seattle</city>
        <state>WA</state>
        <zip>98104</zip>
        <home_phone>(206) 465-4846</home_phone>
        <work_phone>(206) 825-2100 x510</work_phone>
        <email>HRTestEmpWork@ascentis.com</email>
      </contact>
      <issupervisor>true</issupervisor>
      <supervisor>
        <uid>29</uid>
        <firstName>Harold</firstName>
        <lastName>Lu</lastName>
        <middleName>B</middleName>
        <employeeID>7100</employeeID>
        <birthDate xsi:nil="true" />
        <issupervisor>true</issupervisor>
      </supervisor>
    </employee>
    <changes>
      <change>
        <changeId>247</changeId>
        <recordType>Personal</recordType>
        <employeeId>26</employeeId>
        <auditKey1>38</auditKey1>
        <auditKey2>16</auditKey2>
        <action>D</action>
        <auditState>I</auditState>
        <timestamp>2011-11-03T11:04:43.167</timestamp>
        <modifiedBy>Tim Irwin</modifiedBy>
        <items>
          <item>
            <itemId>1111</itemId>
            <field>Designater</field>
            <oldValue>P</oldValue>
            <newValue />
          </item>
          <item>
            <itemId>1112</itemId>
            <field>Percentg</field>
            <oldValue>50.0000</oldValue>
            <newValue />
          </item>
        </items>
      </change>
    </changes>
  </data>
</rawdata>

JSON

{
    "data": [
        {
            "employee": {
                "uid": 26,
                "firstName": "Tanisha",
                "lastName": "Jones",
                "middleName": "",
                "ssn": "458-78-5897",
                "employeeID": "20199",
                "birthDate": "1971-05-24T00:00:00",
                "gender": "F",
                "contact": {
                    "country": "USA",
                    "address1": "120 1st Ave",
                    "address2": "Apt #1101",
                    "city": "Seattle",
                    "state": "WA",
                    "zip": "98104",
                    "home_phone": "(206) 465-4846",
                    "work_phone": "(206) 825-2100 x510",
                    "email": "HRTestEmpWork@ascentis.com"
                },
                "issupervisor": true,
                "supervisor": {
                    "uid": 29,
                    "firstName": "Harold",
                    "lastName": "Lu",
                    "middleName": "B",
                    "employeeID": "7100",
                    "issupervisor": true
                }
            },
            "changes": [
                {
                    "changeId": 247,
                    "recordType": "Personal",
                    "employeeId": 26,
                    "auditKey1": "38",
                    "auditKey2": "16",
                    "action": "D",
                    "auditState": "I",
                    "timestamp": "2011-11-03T11:04:43.167",
                    "modifiedBy": "Tim Irwin",
                    "items": [
                        {
                            "itemId": 1111,
                            "field": "Designater",
                            "oldValue": "P",
                            "newValue": ""
                        },
                        {
                            "itemId": 1112,
                            "field": "Percentg",
                            "oldValue": "50.0000",
                            "newValue": ""
                        }
                    ]
                }
            ]
        }
    ]
}

Resource Information
Requires Authentication?	Yes
Response Formats	json xml
HTTP Methods	GET
Request Content	N/A
Return Code	200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: Employee does not exist
API Version	v1.1 only