SOAP 3 Documentation
Contents |
The EService SOAP 3 API
The SOAP 3 api is an external interface which allows authorised users to directly connect their job management system to the ECONZ EService Job Management and Wireless Dispatch system. The interface allows jobs to be created, updated, dispatched, progressed and comlpeted. In addition, it also allows for the creation and maintenance of customer, resource, and employee data.
The Interface Definition
Below are listed the various functions that make up the SOAP 3 API. Each function is called, passing in at least one parameter, a UserIDBean. This bean contains the user name and password of a previously registered EService User, with administrative rights. This ensures only authorised users are able to access the interface.
Please select a link to see documentation on each method's function and features.
Job Creation and Management Functions
| Method | Summary |
|---|---|
| createJob | Creates a new job based on the job data passed in. |
| updateJob | Updates an existing job, based on the data passed in. |
| progressJobStatus | Moves a job forwards through its logical state transitions. |
| onHoldJob | Places a started job on hold. |
| resumeJob | Resumes a job previously placed on hold. |
| recallJob | Recalls a job previously dispatched to a field worker. Optionally forces return even after the job has been started. |
| confirmJobRecall | Forces completion of the recall, even if the field worker has not confirmed job recall. |
| cancelJob | Cancels an existing job. |
| dispatchJob | Sends the job to the specified field worker. |
| getJobSummary | Retrieves a quick summary of the job, its status, and their customer details. |
| getJobSummaries | Retrieves a series of summaries of requested jobs, their status, and their customer details. |
| getJobSummariesBetween | Retrieves a series of summaries of requested jobs between two selected dates. |
| getJobSummariesBetweenStatusAfterPK | Retrieves a summary of every job who's status lies between status A and status B, inclusive and who's primary key lies after the passed key. |
| getJobDetail | Retrieves the full job details for the specified job. |
| getJobDetails | Retrieves the full job detail for each of the specified jobs. |
| getJobDetailsBetween | Retrieves the full job details for all jobs whose Event fell between the two specified dates. |
| getJobDetailsByExternalRef | Retrieves the full job details for the specified job whose external reference matches the passed in value. |
| getJobAttributeNames | Retrieves the list of all job custom attributes. |
| getJobTypeNames | Retrieves the list of all job types. |
| getUnsynchronisedJobs | Retrieves all jobs whose have not previously been synchronised and acknowledged, and all jobs that have changed since their last synchronisation |
| ackJobSynchronisation | Acknowledges that synchronisation has been performed on the selected jobs. |
Customer Management Functions
* createCustomer * getCustomerDetail * getCustomerDetailByExternalRef * getCustomerDetailsUpdatedSince * updateCustomer * deleteCustomer * getCustomerAttributeNames * getUnsynchronisedCustomers * ackCustomerSynchronisation
EService User Management Functions
* createUser * getUserDetail * updateUser * updateUserPassword * deleteUser * getUnsynchronisedUsers * ackUserSynchronisation
EService Field Device Management Functions
* createFieldDevice * getFieldDeviceDetail * getFieldDeviceDetails * getFieldDeviceDetailsUpdatedSince * updateFieldDevice * deleteFieldDevice * getFieldDevicePKForName * getFieldDevicePKForDeviceID
Resource Management Functions
* getResourceList * createResource * getResource * getResourcesUpdatedSince * deleteResource * getUnsynchronisedResources * ackResourceSynchronisation * getResourceGroups * createResourceGroup * deleteResourceGroup
Callback Functions
* unRegisterCallback * getVersion * registerCallback * getCallbackErrors
