Subscribe-hr Web Service Overview

A: Level 2, Suite 33, 330 Wattle Street, Ultimo, NSW 2007 P: 02 9281 5010 E: [email protected]

Subscribe-Software Pty Ltd ABN: 86 132 590 277

Introduction Subscribe-HR provides a SOAP web service API that enables clients to integrate the Platform with their existing Payroll Software or other Third Party systems. The aim of this document is to provide a brief overview of the features and functionality available when using the service. For more detailed Developer documentation with live samples please contact us before commencing the integration process. The Subscribe-HR Platform consists of standard Objects that interact with each other through the relationship model defined in the Developer Tool. It is this model that makes our API flexible, easy-to-use and re-use throughout the integration process. With only three functions you can access information you need, quickly and effortlessly. By creating new objects using the Developer Tool you will automatically be granted access to those Objects through the API. Brief functional overview: •

queryObject – Get information you need using our query function.

•

createObject – Import new record into the system.

•

updateObject – Update information that is already in the system.

Note: data field specification is auto-generated prior to commencing the integration process.

Subscribe-Software Pty Ltd ABN: 86 132 590 277

Getting Started Please make sure you have completed the following steps before starting to make API calls: 1. Request an “Integrator” account from Subscribe-HR 2. Request unique integration API key from Subscribe-HR 3. Make a list of fields that you want to create/update/export so we can provide selfgenerated Developer documentation. 4. Link to our SOAP service using our secure URL

Subscribe-Software Pty Ltd ABN: 86 132 590 277

Functions 1. queryObject (objectName, queryString)

Parameters: objectName – Name of the object you want to export (e.g. Employee) queryString – Query string (Please refer to Developer document for more information) Output: Returns list of records from an Object based on queryString parameters. All records are returned if queryString is left blank. 2. createObject (objectName, queryString)

Parameters: objectName – Name of the object you want to create (e.g. Employee) queryString – New record XML specification Output: Returns true if record is created, throws an exception on failure. 3. updateObject (objectName, queryString)

Parameters: objectName – Name of the object you want to update (e.g. Employee) queryString – Update record XML specification Output: Returns true if record is updated, throws an exception on failure.

Subscribe-Software Pty Ltd ABN: 86 132 590 277

Validation Before creating or updating an object record standard validation rules will apply. An exception is thrown if one of the fields does not pass the validation process. Rules can be configured using Developer Tool. If you require a document outlining available objects and fields please contact Subscribe-HR so we can generate this document for you. Before modifying any validation rules in the system please make sure that the change will not interrupt information flow from another system.

Service Information Test gateway: Gateway: https://www.subscribe-hr.com/cb/app/general/gateway/test WSDL: https://www.subscribe-hr.com/cb/app/general/gateway/wsdl-test Live gateway: Gateway: https://www.subscribe-hr.com/cb/app/general/gateway/live WSDL: https://www.subscribe-hr.com/cb/app/general/gateway/wsdl-live

Subscribe-Software Pty Ltd ABN: 86 132 590 277