|
GET
list
Example URL:
http://api.workflowmax.com/staff.api/list?apiKey=[your API
key]&accountKey=[WorkflowMax account key]
Example Response:
<Response>
<Status>OK</Status>
<StaffList>
<Staff>
<ID>1</ID>
<Name>Jo Bloggs</Name>
<Email>jo@bloggs.net</Email>
<Phone />
<Mobile />
<Address />
</Staff>
<Staff>
<ID>19</ID>
<Name>John Smith</Name>
<Email>john@smith.com</Email>
<Phone />
<Mobile />
<Address />
</Staff>
</StaffList>
</Response>
GET
get/[id]
Example URL:
http://api.workflowmax.com/staff.api/get/123?apiKey=[your API
key]&accountKey=[WorkflowMax account key]
Example Response:
<Response>
<Status>OK</Status>
<Staff>
<ID>1</ID>
<Name>Jo Bloggs</Name>
<Email>jo@bloggs.net</Email>
<Phone />
<Mobile />
<Address />
<PayrollCode />
</Staff>
</Response>
POST
add
Example URL:
POST http://api.workflowmax.com/staff.api/add?apiKey=[your API
key]&accountKey=[WorkflowMax account key]
Example Message:
<Staff>
<Name>John Smith</Name>
<Address></Address> <!-- optional -->
<Phone></Phone> <!-- optional -->
<Mobile></Mobile> <!-- optional -->
<Email></Email> <!-- optional -->
<PayrollCode></PayrollCode> <!-- optional -->
</Staff>
The response will include the detailed information of the staff
member as per the GET
get/[id] method
PUT
update
Example URL:
PUT http://api.workflowmax.com/staff.api/update?apiKey=[your API
key]&accountKey=[WorkflowMax account key]
Example Message:
<Staff>
<ID>1234</ID>
<Name>John Smith</Name>
<Address></Address> <!-- optional -->
<Phone></Phone> <!-- optional -->
<Mobile></Mobile> <!-- optional -->
<Email></Email> <!-- optional -->
<PayrollCode></PayrollCode> <!-- optional -->
</Staff>
The response will include the detailed information of the staff
member as per the GET
get/[id] method
POST
delete
Example URL:
POST http://api.workflowmax.com/staff.api/delete?apiKey=[your
API key]&accountKey=[WorkflowMax account key]
Example Message:
<Staff>
<ID>1234</ID>
</Staff>
|