This API retrieves existing employee information. This API can be used to retireve employee demographic, contact and supervisor information.
Resource URL| Example Request | |
| GET | https://serverurl/api/v1.1/employee/26 |
| Return Value |
| Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned. |
| XML |
<employee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| JSON |
{ "uid":26, "firstName":"Tanisha", "lastName":"Jones", "middleName":"", "nickName":""," previousName":"", "ssn":"458-78-5897", "employeeID":"20199", "birthDate":"1971-05-24T00:00:00", "gender":"F", "username":"tanishaj", "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":"tjones@snapdist.com", "other_email":"", "addl_contacts": [ { "id":1, "type": "Cell","value":"(206)-658-4389"}, {"id":2,"type":"","value":""}, {"id":3,"type":"","value":""} ] }, "issupervisor":true, "supervisor": {"uid":29, "firstName":"Harold", "lastName":"Lu", "middleName":"B", "employeeID":"7100", "issupervisor":true } } |
| |
| 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 | Version | v1.0, v1.1 (Additional contact info and username added in v1.1 |