You are here: HTTP Services > Get Employee Picture

Get Employee Picture

Summary
Parameters
employeeId
Status Section
Request Section
Result Section

Summary

This service will return an employee's picture. A picture is requested through the employee's home club and is identified by the employee's GUID. A club may or may not store employee pictures.

Service Name	getEmployeePicture
Service Type	HTTP
Invoked by	HTTPS Get Request
Returns	HTTPS Response
URL Format	[server]/ws/getMemberPicture/[club-number]?employeeId=[id]
Required Parameters	employeeId

Parameters

The getEmployeePicture service requires the parameter employeeId.

employeeId

The employeeId parameter is required. It allows you to specify a specific employee, using a unique value, or GUID.

URL Format

[server]/ws/getEmployeeList/[club-number]?employeeId=[id]

The Response is a Standard HTTPS Get Response object containing a message in XML.

The XML message contains three components:

Status
Request
Result

The root tag is getCheckInDetails.

Status Section

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	The response tag contains a value indicating the overall status of the request. The overall status will be one of three values: completed: The service completed successfully. Check ins may or may not have been returned. usageError: Required Request parameters did no pass validation, and no check ins were returned. internalError: System exceptions occurred while executing the web service, and no check ins were returned.
message	string, up to 125 characters	The message tag 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>Service completed successfully</message>\\ <message>Invalid value for parameter employeeId</message>
employeeFound	boolean	A value of true indicates an employee matching the employee Id was found. A value of false indicates that no employee matching this employee Id was found.
pictureFound	boolean	A value of true indicates that the employee's picture was found. A value of false indicates that no employee picture was found. If employeeFound is true and pictureFound is false, this means that the employee has been located but does not have a picture available.

Request Section

The request section lists the values in the original request for club number and start time.

The request section's tag name is request.

Tag Name	Format	Description
clubnumber	####	The club number specified in the request URL.
employeeId	GUID	The employee id specified in the request URL.

Result Section

This section contains the employee's picture.

The result tag contains one tag:

picture

Tag Name	Format	Parent tag	Description
picture	base-64 picture	result	Optional. Contains the base-64 encoded picture for the member indicated by employeeId. This tag will not be returned if there is no picture for the member.