This service will return details for selected employees for a particular club in ABC's club management system. this employee information includes items such as name, address, associated departments, certifications, and general availability.
[server]/ws/getEmployeeList/[club-number] [server]/getEmployeeList/[club-number]?[optionalparameters]
| Service Name | getEmployeeList |
| Service Type | HTTP |
| Invoked by | HTTPS Get Request |
| Returns | HTTPS Response |
| URL Format |
[server]/ws/getEmployeeList/[club-number] |
| Required Parameters | All parameters are optional |
This web service has no required parameters. You may use one or more optional parameters:
When you do not specify any parameters, the web service returns a list of all employees, regardless of status.
The employeeId parameter allows you to specify a specific employee, using a unique value, or GUID.
| URL Format |
[server]/getEmployeeList/[club-number]?employeeId=[id] |
The employeeStatus parameter allows you to specify whether you want to retrieve active employees, inactive employees, or both, based on the setting of the DataTrak Employee Active Flag.
The employeeStatus parameter uses the Employee Active Flag, and not the termination date.
Using the Employee Active Flag was implemented on January 31, 2010.
| URL Format | [server]ws/getEmployeeList/[club-number]?employeeStatus=[active|inactive|all] |
| Allowed Values |
|
The employeeBarcode parameter allows you to specify an employee by barcode. Clubs assign barcodes.
| URL Format | [server]/ws/getEmployeeList/[club-number]?employeeBarcode=[barcode] |
The departmentOnline parameter allow you to limit the results to employees based on whether they belong to an online department.
Online employees make their information available to the MYiCLUBonline.
| URL Format | [server]/ws/getEmployeeList/[club-number]?departmentOnline=[true|false] |
| Allowed Values |
|
The Response is a Standard HTTPS Get Response object containing a message in XML.
The XML message contains three sections:
The root tag is getEmployeeList.
This section describes the overall status of the request. The Status section's tag name is <status>.
The <status> tag contains the following tags:
| response | string, up to 50 characters |
Contains a value indicating the overall status of the request. The overall status will may be one of three values:
|
| message | string, up to 125 characters |
Provides a more specific description of the result value. Each message tag includes an attribute. The id attribute is assigned a unique id. Example tags and values include:
<message id="0">Service completed successfully</message>
|
| employeesReturned | integer |
Contains a value corresponding to the number of members returned in the response. If the service returns no members, then the value is 0. Example tag with value:
<membersReturned>5574</membersReturned>
|
This section lists what the original request contained. The Request section's tag name is <request>.
Tags included in the request tag may include:
| Tag Number | Format | Description |
|---|---|---|
| clubNumber | #### | The club number specified in the request URL. |
| employeeId | GUID |
Omitted if parameter was not used in the URL. Contains the value for the parameter, if used. |
| employeeStatus | string |
Omitted if parameter was not used in the URL. Contains the value for the parameter, if used. |
| employeeBarcode | barcode |
Omitted if parameter was not used in the URL. Contains the value for the parameter, if used. |
| departmentOnline | boolean |
Omitted if parameter was not used in the URL. Contains the value for the parameter, if used. |
This section contains specific information about each employee returned, if any.
The result tag contains the following tags. The root tag is employees.
| Tag Name | Format | Parent Tag | Description |
|---|---|---|---|
| employee | GUID | employees |
Contains the id attribute equal to a GUID. Contains employee-specific information in the following tags and their child tags.
Child tags:
There may be zero, one, or many employee tags, depending on the number of results returned. |
| employeeBarcode | barcode | employee | Optional. The barcode value for the employee. |
| personal | employee |
Groups together personal employee information such as name and birthdate.
Child tags:
|
|
| ssn | personal | Contains the employee's social security number. This tag is not currently supported and will return no data. In the past, the ssn tag would return a value including the last four digits of the employee's social security number. |
|
| firstName | string, up to 15 characters | personal | Contains the first 15 characters of the employee's first name in uppercase. |
| middleInitiial | string, 1 character | personal | Optional. Contains the value for the employee's middle initial. One character in uppercase. |
| lastName | string, up to 19 characters | personal | Contains the first 19 characters of the employee's last name in uppercase. |
| birthDate | YYYY-MM-DD | personal | Optional. Contains the value for the employee's birthdate. |
| profile | string, up to 4000 charcters | personal | Optional. Contains the employee's profile. This information is free-form text maintained by the club. |
| contact | employee |
Contains contact information for the employee, using child tags.
Child tags:
|
|
| address | string, up to 40 characters | contact | Optional. Contains the employee's street address in uppercase. |
| city | string, up to 17 characters | contact | Optional. Contains the employee's city in uppercase. |
| state | State Code | contact | Optional. Contains the value for the employee's state of residence in uppercase. |
| zip | string, up to 10 characters | contact | Optional. Contains the value for the employee's zip code. |
| string, up to 60 characters | contact | Optional. Contains the value for the employee's email address. | |
| homePhone | Phone Number | contact | Optional. Contains the value for the employee's home phone number as digits only. Example: 5015555555 |
| cellPhone | Phone Number | contact | Optional. Contains the value for the employee's cell phone number. |
| workPhone | Phone Number | contact | Optional. Contains the value for the employee's work phone number. |
| workPhoneExtension | string, up to four characters | contact | Optional. Contains the extension for the emergency phone number. |
| emergencyPhone | Phone Number | contact | Optional. Contains the phone number for the employee's emergency contact. |
| emergencyPhoneExtension | string, up to four characters | contact | Optional. Contains the extension for the emergency phone number. |
| employment | employee |
Contains employment information such as wage and start date in its child tags.
Child tags:
|
|
| wage |
string, up to nine characters - formatting restrictions |
employment |
Contains the employee's wage, using up to eight digits. If the wage value is a whole number, the value will display without decimals. The default value is zero (0).
|
| commissionLevel | employment |
Contains the commission level. Defaults to zero.
Allowed values:
|
|
| startDate | YYY-MM-DD | employment | Contains the date on which the employee starts or started employment. |
| terminationDate | YYYY-MM-DD | employment | Contains the date on which the employment was terminated. |
| authorizedClubs | employment |
Contains one or more clubNumber tags for any club or clubs where the employee is authorized to work.
Child tag:
|
|
| clubNumber | #### | authorizedClubs | Contains the club number for an authorized club. There may be zero, one, or many clubs for a single employee. The tag repeats for each club. |
| departments | employment | Contains zero, one, or more department tags describing departments that the employee is assigned to. | |
| department | string | departments | Contains the name of the department the employee is assigned to. Repeats for each department. |
| trainingLevel | employment |
Contains the value for the employee's training level.
Allowed values:
|
|
| certifications | string | employee |
Contains a certification tag for each certification held by the employee. There may be zero, one, or many certification tags for a single employee.
Child tags:
|
| certification | certifications |
Contains the details for a single certification in its tags. This tag repeats for each certification.
Child tags:
|
|
| name | string | certification | Contains the name of the certification |
| description | string | certification | Contains a description of the certification. |
| number | certification | ||
| issuingAgency | string | certification | Contains the name of the issuing agency for the certification |
| acquiredDate | YYYY-MM-DD | certification | Contains the date the certification was acquired. |
| expiredDate | YYYY-MM-DD | certification | Contains the date the certification expired. |
| generalAvailability | employee |
Contains the employee's daily availability for the days of the week. There may be zero, one, or many available tags.
Child tag:
|
|
| available | generalAvailability |
Contains a description of an employee's availability based on the date of the week. For each available tag, all child tags are required.
Child tags:
|
|
| dayOfWeek | integer | available |
Describes a day of the week for an availability period, using a number code from 0-6 for each day of the week.
Allowed values:
|
| startTime | HH:MM | available | Describes the beginning time for an availability period. |
| endTime | HH:MM | available | Describes the ending time for an availability period. |