API:API Employees(Legacy)
From HasOffers
Contents |
Definition
Returns a list of employees.
- URLs: http://demo.hasoffers.com/admin/api/v1/employees.format
- Formats: json, xml, csv
- HTTP Method: GET
- Authentication: This API requires user authentication. Your API key should be passed with the request to provide authentication.
Required Parameters
- api_key The API Key used as authentication.
Optional Parameter
- limit The maximum number of results that should be returned. 0 is unlimited results. Default is 0.
- page The page number of the result set to coincide with the provided limit. Default is 1.
JSON Example
.
<code>
{
"success":true
,"rows":2
,"total_rows":5
,"data":{
"employees":[
{
"id":"1"
,"email":"demo@hasoffers.com"
,"first_name":"Demo"
,"last_name":"Account"
,"home_phone":"555-5555"
,"cell_phone":"555-5555"
,"aim":"demo@example.org"
,"title":""
,"join_date":"2009-04-16 13:55:52"
,"last_login":"2009-07-27 17:36:58"
,"status":"active"
,"photo":"http:\/\/cdn.go2media.org\/user_content\/brand\/logos\/\/demo\/4a035b11a0a73.gif"
}
,{
"id":"2"
,"email":"bob@hasoffers.com"
,"first_name":"Bob"
,"last_name":"Doe"
,"home_phone":"123-8787"
,"cell_phone":"456-7878"
,"aim":""
,"title":""
,"join_date":"2009-04-16 15:13:13"
,"last_login":"2009-07-10 15:45:33"
,"status":"active"
,"photo":""
}
]
}
}
</code>
XML Example
.
<code>
<rsp stat="ok" rows="2" total_rows="5">
<employee>
<id>1</id>
<email>demo@hasoffers.com</email>
<first_name>Demo</first_name>
<last_name>Account</last_name>
<home_phone>555-5555</home_phone>
<cell_phone>555-5555</cell_phone>
<aim>demo@example.org</aim>
<title/>
<join_date>2009-04-16 13:55:52</join_date>
<last_login>2009-07-27 17:36:58</last_login>
<status>active</status>
<photo>
http://cdn.go2media.org/user_content/brand/logos//demo/4a035b11a0a73.gif
</photo>
</employee>
<employee>
<id>2</id>
<email>bob@hasoffers.com</email>
<first_name>Bob</first_name>
<last_name>Doe</last_name>
<home_phone>123-8787</home_phone>
<cell_phone>456-7878</cell_phone>
<aim/>
<title/>
<join_date>2009-04-16 15:13:13</join_date>
<last_login>2009-07-10 15:45:33</last_login>
<status>active</status>
<photo/>
</employee>
</rsp>
</code>
Email this page to a friend or co-worker
