Memberships REST API

Get list of memberships types (products) which are active and can be sold: UploadMembershipProducts()

UploadMembershipProducts() :Text

This function returns a JSON with a list of membership types (products) which are active and can be sold.

Sell membership to a client: SellMembership()

SellMembershipV2(ClientNo: Code[20];MembershipNo: Code[20]): Text

Sell membership (membership type) to a client.

If this is a single-sale product, details for the retail basket are returned, and w hen payment arrives through Commerce imports, the membership is activated.
If this is a subscription product, basket details are not returned but the membership is activated.

Note: Status to activate must be set up in the membership setup, otherwise memberships will have status Draft and must be activated manually. The booking reference to Commerce is returned as part of the response.

Example of RESPONSE:

Cancel a specific membership and validate if cancellation is in order: CancelMembership()

CancelMembership(ClientNo: Code[20];MembershipNo: Code[20]; Comment: Text[100]): Text

Cancels a specific membership and validates if cancellation is in order (that is compares to the commitment period).

Get list of the clients currently active or on hold memberships: UploadMembershipEntries()

UploadMembershipEntries(ClientNo: Code[20]):Text

This function returns a JSON with a list of the client's currently active or on hold memberships. This filters membership entries with status Active or On Hold.

Get list of subscription charges of client/member: UploadMembershipSubscriptionCharges()

UploadMembershipSubscriptionCharges(ClientNo: Code[20]):Text

This function returns a JSON with a list of all subscription charges posted towards their membership account. Unposted draft entries are not included.

Get list of all entries charged to client/customer accounts: UploadCustomerEntries()

UploadCustomerEntries(ClientNo: Code[20];CustomerNo: Code[20]):Text

This function returns a JSON with a list of all entries charged to the client's customer accounts (A/R). The Account number is based on the contact business relation settings.

Get list of client's visit registration: UploadAdmissionEntries()

UploadAdmissionEntries(ClientNo: Code[20]):Text

This function returns a JSON with a list of client's visit registration.

Get detailed information on member/client: UploadMemberDetails()

UploadMemberDetails(ClientNo: Code[20]) :Text

This function returns a JSON with detailed information on the member or client.

Put deposit on member deposit account: InsertMemberDeposit()

InsertMemberDeposit(ClientNo: Code[20]; Amount: Decimal) : Text

Allows members to put deposit on their member deposit account.

This function returns a JSON with a booking reference and item to use for charging basket.

Confirm all activities in a reservation: ConfirmReservation()

ConfirmReservation(ReservationNo: Code[20]) :Text

Confirm all activities in a reservation. The ReservationNo. parameter is required.

Cancel all activities in a reservation: CancelReservation()

CancelReservation(ReservationNo: Code[20]) : Text

This function cancels all activities in a reservation. The ReservationNo. parameter is required.

Get reservation or list of reservations based on date of change and/or location: GetActReservations()

GetActReservations(ReservationNo: Code[20]; LocationNo: Code[20]; ReservationType: Code[20]; Status: Code[20]; FromDateTime: DateTime) :Text

Get reservation header or list of reservation headers based on the date of change and/or location.

If ReservationNo. is blank, multiple entries are returned.

If ReservationNo. is set, a single reservation is retrieved.

If Date/time is not set, all entries are retrieved.

LocationNo. is optional. Optional filtering on Reservation type and Status. Leave Reservation type and Status blank, if not required.

Get valid access for either membership or ticketing: CheckAccess()

CheckAccess(SearchReference: Code[20]; LocationNo: Code[20]; GateNo: Code[20]; RegisterAccessEntry: Boolean; CheckType: Integer) :Text

Checks if access is valid for either membership or ticketing.

SearchReference is either TicketBarcode, Member No. or Membership No.

CheckType = 0 All checks, 1 = CheckTicket only, 2 = CheckMembership only.

Optional parameters:

LocationNo optional Activity Location,
Gate number
RegisterAccessEntry = Set if to register admission.