You are here: HTTP Services > Agreement List

Agreement List

Summary
Parameters
startDate
endDate
Response Data
Agreement List Response Section

Summary

The agreementlist service returns all of the agreements for a specific date range submitted to ABC through Electronic Agreement Entry (EAE). The range can be up to and including 31 days in duration.

Service Name	agreementlist
Service Type	HTTP
Invoked by	HTTPS GET Request
Returns	HTTPS Response
URL Format	[server]/ws/agreementlist/[club-number]?startDate=[YYYY-MM-DD]&endDate=[YYYY-MM-DD]
Required Parameters	startDate endDate

Parameters

agreementlist requires two parameters:

startDate: The agreement's created date will be later than (greater than) or equal to the startDate.
endDate: The agreement created date will be earlier than (lesser than) the endDate.

Together, the startDate and endDate can define a range no longer than 31 days in duration.

To request agreements for a single day, set the startDate to the desired date and add one day to the endDate.
Example:
To select May 1, 2012:

Set startDate: 2012-05-01
Set endDate: 2012-05-02

To request agreements for a single month, set the startDate to the first day of the desired month and set the endDate to the first day of the following month.
Example:
To select January 2012:

Set startDate: 2012-01-01
Set endDate: 2012-02-01

startDate

When specifying the startDate, use the date format YYYY-MM-DD. For example, for a date range beginning December 28, 2012, the URL would include startDate=2012-12-28.

endDate

When specifying the endDate, use the date format YYY-MM-DD. For example, for a date range ending January 4, 2013, the URL would include endDate=2013-01-04.

Response Data

The Response is a Standard HTTPS Get Response object containing a message in XML. The XML message contains one section:

Agreement List Response

Agreement List Response Section

This section contains specific information about each transaction for the desired club. The Agreement List Response section's tag name is agreementListResponse. It contains the following tags:

clubnumber
agreements
agreement
agreementNumber
queueName
membershipType
active
createDate
joinedDate
signedDate
downPayment
salePrice
renewalType
agreementType

Note: When a valid response contains no agreements, the agreements tag will contain no child tags.

Tag Name	Format	Parent Tag	Description
clubnumber	####	agreementListResponse	Contains the club number from the original request.
agreements		agreementListResponse	Contains zero, one, or many agreement tags. There is one agreement tag for each agreement returned in the request.
agreement		agreements	Contains the agreement details for individual agreements that fit the criteria in the Request URL. There is an agreement tag with a relevant child tag for each result. Child Tags: agreementNumber queueName membershipType active createDate joinedDate signedDate downPayment salePrice renewalType agreementType
agreementNumber	string	agreement	Contains the member's agreement number, using the following guidelines: Prospects: Use the format of ####PROSP, where #### is equal to the club's number. Secondary Members: Have the agreement number of the corresponding primary member. ABC-Managed Members: Whether primary or secondary, limited to nine characters. Club-Managed Members: Whether primary or secondary, limited to twelve characters. The underscore character (_) is for display purposes only. It separates the club number from the rest of the agreement number. When entering an agreement number, do not use an underscore.
queueName	string	agreement	Optional. Contains the queue to which the agreement is assigned.
membershipType	string	agreement	Contains a label for the membership type.
active		agreement	The active tag contains a value of true or false. When the value is false, the agreement is inactive and in one of the following states: Expired Cancelled Return for Collection Prospect
createdDate	YYYY-MM-DD	agreement	The date the agreement was entered into ABC systems.
joinedDate	YYYY-MM-DD	agreement	The join date for the agreement.
signedDate	YYYY-MM-DD	agreement	The date the member signed the agreement.
downPayment	######.##	agreement	Contains the value for the amount the club received as a down payment for this agreement.
salePrice	######.##	agreement	Optional. Contains a value for the total value of the agreement through its expiration date. The salePrice calculation includes the down payment, remaining dues, and any scheduled fees the club charges over the duration of the agreement term. Scheduled fees include items such as enhancement fees and joining fees.
renewalType		agreement	Contains the agreement's renewal type. Allowed values: Auto-Renew Open Auto-Renew Term Manual None
agreementType		agreement	An agreement may be one of three types: Allowed values: New Renewal Rewrite Convert