MembershipType

APIDescription
GET member_services/MembershipType

This method will return all the individual membership and packages setup to sell online. IsMemberShipPackage flag will be true for package and for individual membership this flag will be false. If it is a package and price is set on individual membership based then cost will be 0 otherwise cost will be whole package cost. SortSequnce number is to sort out the membership for display purpose.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Request satisfied, data included in body.

GET member_services/MembershipType?PackageID={PackageID}

This will return all the membership in a package, which is passed as a parameter to this method.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Request satisfied, data included in body.

Authentication

APIDescription
POST member_services/Authentication

This method is used to authenticate member information and return the corresponding member object.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Details authenticated.

Not Found - No member matches the supplied request.

Not Acceptable - Authentication denied.

Bad Request - Supplied authentication request object contains invalid data.

VisitHistory

APIDescription
GET member_services/VisitHistory/{code}

This method will return the list of visits recorded for the specified member. If the specified member is a primary family member, visits for the entire family will be included.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Request satisfied, data included in body.

Not Found - Member with supplied code could not be found.

Diagnostics

APIDescription
GET member_services/Diagnostics

This method provides basic diagnostic information describing the current state of the API and confirms that required settings have been configured in Centaman. No credentials are required to access this endpoint.

Return Codes:

OK - Request satisfied, data included in body.

Membership

APIDescription
PUT member_services/Membership/{code}

This method allows updates to memberships in the Centaman database. The request should include the unique linkfield of the membership in the URL and a membership object containing the modified fields as the body.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Membership updated successfully.

Not Found - The membership to update could not be found.

Bad Request - Supplied membership object is invalid.

POST member_services/Membership?isNew={isNew}&extendNewRenewals={extendNewRenewals}

This method allows the creation of new memberships and transaction records indicating the purchase of a membership. Posted memberships should only contain 'core' fields, the remaining fields will be generated internally.

Requires: HTTPS, Basic Auth.

Return Codes:

Created - Memberships created.

Bad Request - Supplied membership objects were invalid.

TransactionHistory

APIDescription
GET member_services/TransactionHistory/{code}

This method will return the list of transaction recorded for the specified member. If the specified member is a primary family member, transactions for the entire family will be included.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Request satisfied, data included in body.

Not Found - Member with supplied code could not be found.

IncompleteMember

APIDescription
GET member_services/IncompleteMember?from={from}&to={to}

This method provides a list of all members created in the specified date range that are flagged as incomplete and are not unclaimed gift membership recipients. DateTime members should be in the form '2014-01-13T00:00:00'.

Requires: HTTPS, Basic Auth. Return Codes:

OK - Request satisfied, data included in body.

UDF

APIDescription
GET member_services/UDF/{code}

This method will return user defined fields corresponding to the requested member as they are defined in the database.

Requires: HTTPS, Basic Auth.

Return Codes:

OK - Request satisfied, data included in body.

Not Found - Member with supplied code could not be found