This service will return a member's picture. A picture is requested through the member's home club and is identified by the member GUID or barcode. Al club may or may not store member pictures.
| Service Name | getMemberPicture |
| Service Type | HTTP |
| Invoked by | HTTPS GET Request |
| Returns | HTTPS Response |
| URL format |
[server]/ws/getMemberPicture/[club-number]?memberId=[id] |
| Required Parameters | memberId OR barcode |
The getMemberPicture service requires one parameter and allows only one parameter at a time. The parameter may be either a member id (GUID) or a barcode.
Use only one parameter with getMemberPicture: either member id or barcode.
The memberId uniquely identifies a member within a particular club. ABC assigns memberIds in the form of a GUID.
Clubs assign barcode values to members.
The Response is a standard HTTPS GET Response object containing a message in XML.
The XML Message contains three sections:
The root tag is getMemberPicture.
The Status section's tag name is status. The status tag contains the following tags:
| Tag Name | Format | Description |
|---|---|---|
| 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:
|
| 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>\\ |
| memberFound | boolean | The memberFound tag has a value of true if the member was found. |
| pictureFound | boolean | A member may or may not have a picture. When pictureFound has a value of true, the member's picture will be included in the response. |
The Request section lists the values in the original request for club numbers identifying member information.
The Request section's tag name is request.
| Tag Name | Format | Description |
|---|---|---|
| clubNumber | #### | The club number specified in the request URL. |
| memberId | GUID |
The memberId tag appears if the service was invoked with the memberId parameter. This tag contains a value equal to the memberId parameter sent in through the request. |
| barcode | barcode |
The barcode tag appears if the service was invoked with the barcode parameter. This tag contains a value equal to the barcode parameter sent in through the request. |
The Result section contains the member's picture. The tag name for the section is result. It contains the following tags:
| Tag Name | Format | Description |
|---|---|---|
| picture | base-64 encoded picture | The picture tag contains the base-64 encoded picture for the indicated member. This tag will not exist if the member does not have a picture. |