Resource Definitions:Agents
From API Documentation
(→GET) |
(→GET) |
||
| Line 11: | Line 11: | ||
'''''Example Response - XML''''' | '''''Example Response - XML''''' | ||
| - | <source lang="xml"><?xml version="1.0" encoding="UTF-8"?> | + | <source lang="xml"> |
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
<agents version="1.0"> | <agents version="1.0"> | ||
<agent> | <agent> | ||
| Line 25: | Line 26: | ||
'''''Example Response - JSON''''' | '''''Example Response - JSON''''' | ||
| - | <source lang="javascript">[ | + | <source lang="javascript"> |
| + | [ | ||
{ | { | ||
"user_id":"1234", | "user_id":"1234", | ||
| Line 37: | Line 39: | ||
</source> | </source> | ||
| - | + | '''''Example Response - TEXT (pipe-delimited)''''' | |
| - | + | <source lang="csv"> | |
| - | + | 1234|john.smith@company.com|John|Smith|2010-06-25 20:00:00 | |
| - | + | ... | |
| + | </source> | ||
[[Category:Resource Definitions]] | [[Category:Resource Definitions]] | ||
Revision as of 14:46, 12 July 2010
The agents resource is a collection of all agent accounts associated with your company. Available methods are:
GET
Returns a list of agents. Each agent record includes the following fields:
- user_id,
- user_email,
- user_fname,
- user_lname,
- user_date
Example Response - XML
<?xml version="1.0" encoding="UTF-8"?> <agents version="1.0"> <agent> <user_id>1234</user_id> <user_email>john.smith@company.com</user_email> <user_fname>John</user_fname> <user_lname>Smith</user_lname> <user_date>2010-06-25 20:00:00</user_date> </agent> ... </agents>
Example Response - JSON
[ { "user_id":"1234", "user_email":"john.smith@company.com", "user_fname":"John", "user_lname":"Smith", "user_date":"2010-06-25 20:00:00" }, ... ]
Example Response - TEXT (pipe-delimited)
GeSHi Error: GeSHi could not find the language csv (using path /var/api/htdocs/api/documentation/extensions/SyntaxHighlight_GeSHi/geshi/geshi/) (code 2)
You need to specify a language like this: <source lang="html4strict">...</source>
Supported languages for syntax highlighting:
abap, actionscript, actionscript3, ada, apache, applescript, apt_sources, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, d, delphi, diff, div, dos, dot, eiffel, fortran, freebasic, genero, gettext, glsl, gml, gnuplot, groovy, haskell, html4strict, idl, ini, inno, io, java, java5, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, per, perl, php, php-brief, plsql, powershell, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vb, vbnet, verilog, vhdl, visualfoxpro, winbatch, xml, xorg_conf, xpp, z80
