Get started

    API BASE URL

                
                

The SGA API provides programmatic access to Sales data.

To use this API, you need a Client ID, Client Secret, Redirect Url, and Client Refresh token. Please contact SGA to get your client credentials.

Security warning:

Calls to this API should only be done with server side code. If an unauthorized user gets access to your Client ID, Client Secret, Redirect Url, and Client Refresh token, they would be able to access all methods exposed through this API.

Pulse User Permissions

A user must be set up in SGA which grants them access to Pulse information. The minimum permission needed is Sales - _Usage (Allow). If the API user does not have this permission no other information will be obtained, regardless of additional permissions. Further permissions needed are defined under each endpoint.

SGA Accounting User Permissions

A user must be set up in SGA which grants them access to SGA Accounting information. The minimum permission needed is General Ledger- _Usage (Allow). If the API user does not have this permission no other information will be obtained, regardless of additional permissions. Further permissions needed are defined under each endpoint.

Get access token for client credentials

# Curl example
curl \
-X POST {baseUrl}/Sales/API/Login/oauth2 \
-H 'Authorization: Bearer {refresh_token}' \
-F 'grant_type=client_credentials' \
-F 'client_id={client_id}' \
-F 'client_secret={client_secret}' \
-F 'redirect_uri={redirect_uri}' 
                

Step 1: Get access token with POST request

To generate an access_token for your client credentials you must make a POST request to the following URL:
/Sales/API/Login/oauth2 with the POST parameters of {refresh_token}, {client_id}, {client_secret}, and {redirect_uri} matching your client credentials.

Your {refresh_token} must be present in the header of the request as Authorization: Bearer {refresh_token}

Step 2: Use access token to access API

To make calls to the API, a valid access_token must be present in the header of the request as Authorization: Bearer {access_token}

Result example :

{
  "access_token": "sdS3vboo8gHMShXfKGkR...",
  "expires_in": "3600",
  "token_type": "bearer"
}
                

POST PARAMETERS

RESPONSE

Get access token for user

# Login url example
/Sales/API/Login?client_id={client_id}&response_type=code&redirect_uri={redirect_uri}&response_mode=query&state={state}

# Curl example to exchange code for access token
curl \
-X POST {baseUrl}/Sales/API/Login/oauth2 \
-H 'Authorization: Bearer {refresh_token}' \
-F 'grant_type=authorization_code' \                         
-F 'client_id={client_id}' \
-F 'client_secret={client_secret}' \
-F 'code={code}' \
-F 'redirect_uri={redirect_uri}' 
                

Step 1: Redirect user to login

To generate an access_token for a user's credentials you must first redirect the user to the following URL:
/Sales/API/Login?client_id={client_id}&response_type=code&redirect_uri={redirect_uri}&response_mode=query&state={state} with the query parameters of {client_id}, and {redirect_uri} matching your client credentials. And {state} matching a randomly generated number to check when the user is redirected back to your site's redirect uri.

Step 2: Handle user redirect after login

After the user logins in on the above url, the user will be redirected back to your site via the {redirect_url} with the query parameters of code and state.

An example redirect URL may look like:
{redirect_uri}?code=FbVEOep9qOATWdn4K5u7xz8qOC&state=1234

Once the user has been redirect back to your site, first verify that the state query parameter matches the state parameter you sent to the /Sales/API/Login endpoint to prevent cross site request forgery attacks.

Step 3: Get access token for code

Then exchange the code for an access token by making a POST request to the following URL:
/Sales/API/Login/oauth2 with the POST parameters of {client_id}, {client_secret}, {redirect_uri} matching your client credentials and code matching the code above.

Your {refresh_token} must be present in the header of the request as Authorization: Bearer {refresh_token}

Step 4: Use access token to access API

To make calls to the API, a valid access_token must be present in the header of the request as Authorization: Bearer {access_token}

Alternative password grant_type:

NOTE: Before using this option, you must consult with SGA Software first. This method requires pre-approval by SGA Software and any clients.

To generate an access_token for a member without a redirect, a {grant_type} of 'password' can be used. This method of generating an access token only works with member accounts and requires the {Email} and {Password} POST parameters to be passed to the /Sales/API/Login/oauth2 end point.

You can exchange member information for an access token by making a POST request to the following URL:
/Sales/API/Login/oauth2 with the POST parameters of {grant_type}, {client_id}, {client_secret}, {redirect_uri}, {Email}, and {Password}. The optional POST parameter of {AccessID} can be used in place of {Email} to refer to the member associated with the passed {AccessID}.

WARNING: Member passwords should never be stored on your site.

Access token result example :

{
  "access_token": "sdS3vboo8gHMShXfKGkR...",
  "expires_in": "3600",
  "token_type": "bearer",
  "refresh_token": "85544545HM5ShXf54k1...",
  "MemberID": 12345,
  "FamilyID": 0
}
                

POST PARAMETERS

RESPONSE

Search for members

Required Permission: Sales-Members(Modify)

# Example Search members URL
/Sales/API/Member?MemberType=I&DisplayStart=0&DisplayLength=100
                

To search members you must make a GET request to the following URL:
/Sales/API/Member

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing members.

The DisplayStart and DisplayLength parameters can be passed to indicate how many members to return

Result example :

                         [
                    {"MemberID":12345,
                    "FamilyID":0,
                    "MemberFamilyID":"12345-0",
                    "IsPrimary":true,
                    "ProfileID":null,
                    "Username":"12345",
                    "BranchID":500,
                    "MemberType":"I",
                    "Salutation":"",
                    "FirstName":"John",
                    "MiddleName":"",
                    "LastName":"Doe",
                    "Suffix":"",
                    "FullName":" John Doe",
                    "FamilyOrganizationName":"Doe Family",
                    "FirstLastName":"John Doe",
                    "FirstMiddleLastName":"John Doe",
                    "LastFirstName":"Doe, John",
                    "LastFirstMiddleName":"Doe, John",
                    "OrganizationName":"",
                    "DisplayName":"John Doe",
                    "Alias":"",
                    "HasAlias":false,
                    "OrganizationTypeID":0,
                    "Website":"",
                    "BirthDate":"1965-01-01T00:00:00",
                    "Age":55,
                    "Gender":"M",
                    "GenderName":"Male",
                    "PreferredAddressID":1,
                    "PreferredAddress":{"MemberID":12345,"AddressID":0,"AddressTypeID":"Home","Address1":"123 Example road","Address2":"","City":"Example city","State":"CA","Zip":"123456","ZipExt":null,"CountryID":"US","PositionName":"","OrganizationName":"","IsPreferred":false},
                    "HasPreferredAddress":true,
                    "PreferredPhoneID":1,
                    "PreferredPhone":{"MemberID":12345,"PhoneID":0,"PhoneTypeID":"Home","PhoneNumber":"555-555-5555","Extension":"","CountryID":"US","ReceiveTextAlerts":true,"PhoneWithExtension":"555-555-5555","IsPreferred":false},
                    "HasPreferredPhone":true,
                    "PreferredEmailID":1,
                    "PreferredEmail":{"MemberID":12345,"EmailID":0,"EmailTypeID":"Home","EmailAddress":"johndoe@gmail.com","IsPreferred":false},
                    "HasPreferredEmail":true,
                    "ActiveMembershipID":12345,
                    "Position":"",
                    "PositionName":null,
                    "Organization":null,
                    "OrganizationTypeName":null,
                    "ActiveMembership":{"RegistrationID":12345,"BranchName":"YMCA -Branch","ProductName":"Adult Membership (Ages 28-64)","StatusID":"A","BeginDate":"2018-05-12T00:00:00","EndDate":"9999-12-31T00:00:00","CancellationID":0,"MembershipClass":"I","MembershipLevel":"F","AllowAccess":true,"InCart":false,"BillingFrequency":null,"BillingFrequencyName":null,"RecurringHold":false,"RecurringHoldBeginDate":"0001-01-01T00:00:00","RecurringHoldEndDate":"0001-01-01T00:00:00","Url":"/Sales/MemberActivity?MemberID=12345","MemberID":12345,"FamilyID":0,"ActivityID":1111,"_Year":9999,"Year":9999,"_Period":99,"Period":99,"ActivityCode":"110-500-9999-99-1111-99","_ProductTypeID":110,"ProductTypeID":110,"_BranchID":500,"BranchID":500,"_ProductID":1111,"ProductID":1111,"_UnitID":99,"UnitID":99,"Modifiers":null},
                    "HasActiveMembership":true,
                    "JoinDate":"2017-02-11T00:00:00",
                    "AccessID":"123456",
                    "DenyAccess":true,
                    "DenyRecurringHold":false,
                    "HasFutureRecurringHold":false,
                    "DenySales":false,"Status":1,
                    "Deceased":false,
                    "Hide":false,
                    "AllowHide":false,
                    "HasImage":true,
                    "ModifyDate":"2019-12-01T12:55:27.007"
                }]
                

QUERY PARAMETERS

RESPONSE

Get member details

Required Permission: Sales-Members(Allow)

# Example get details for single member URL
/Sales/API/Member/12345-0
                

To get details for a single primary member you must make a GET request to the following URL:
/Sales/API/Member/{MemberID}

To get member details for a Member ID and Family ID you must make a GET request to the following URL:
/Sales/API/Member/{MemberFamilyID}

{MemberID} or {MemberFamilyID} are required URL route parameters. {MemberFamilyID} represents the MemberID-FamilyID combination for a single member. When just {MemberID} is used, the primary member of a family will be gotten.

If the request is successful, a HTTP 200 response will be returned with a JSON object representing the member.

Result example :

{
  Member:{"MemberID":12345,
                    "FamilyID":0,
                    "MemberFamilyID":"12345-0",
                    "IsPrimary":true,
                    "ProfileID":null,
                    "Username":"12345",
                    "BranchID":500,
                    "MemberType":"I",
                    "Salutation":"",
                    "FirstName":"John",
                    "MiddleName":"",
                    "LastName":"Doe",
                    "Suffix":"",
                    "FullName":" John Doe",
                    "FamilyOrganizationName":"Doe Family",
                    "FirstLastName":"John Doe",
                    "FirstMiddleLastName":"John Doe",
                    "LastFirstName":"Doe, John",
                    "LastFirstMiddleName":"Doe, John",
                    "OrganizationName":"",
                    "DisplayName":"John Doe",
                    "Alias":"",
                    "HasAlias":false,
                    "OrganizationTypeID":0,
                    "Website":"",
                    "BirthDate":"1965-01-01T00:00:00",
                    "Age":55,
                    "Gender":"M",
                    "GenderName":"Male",
                    "PreferredAddressID":1,
                    "PreferredAddress":{"MemberID":12345,"AddressID":0,"AddressTypeID":"Home","Address1":"123 Example road","Address2":"","City":"Example city","State":"CA","Zip":"123456","ZipExt":null,"CountryID":"US","PositionName":"","OrganizationName":"","IsPreferred":false},
                    "HasPreferredAddress":true,
                    "PreferredPhoneID":1,
                    "PreferredPhone":{"MemberID":12345,"PhoneID":0,"PhoneTypeID":"Home","PhoneNumber":"555-555-5555","Extension":"","CountryID":"US","ReceiveTextAlerts":true,"PhoneWithExtension":"555-555-5555","IsPreferred":false},
                    "HasPreferredPhone":true,
                    "PreferredEmailID":1,
                    "PreferredEmail":{"MemberID":12345,"EmailID":0,"EmailTypeID":"Home","EmailAddress":"johndoe@gmail.com","IsPreferred":false},
                    "HasPreferredEmail":true,
                    "ActiveMembershipID":12345,
                    "Position":"",
                    "PositionName":null,
                    "Organization":null,
                    "OrganizationTypeName":null,
                    "ActiveMembership":{"RegistrationID":12345,"BranchName":"YMCA -Branch","ProductName":"Adult Membership (Ages 28-64)","StatusID":"A","BeginDate":"2018-05-12T00:00:00","EndDate":"9999-12-31T00:00:00","CancellationID":0,"MembershipClass":"I","MembershipLevel":"F","AllowAccess":true,"InCart":false,"BillingFrequency":null,"BillingFrequencyName":null,"RecurringHold":false,"RecurringHoldBeginDate":"0001-01-01T00:00:00","RecurringHoldEndDate":"0001-01-01T00:00:00","Url":"/Sales/MemberActivity?MemberID=12345","MemberID":12345,"FamilyID":0,"ActivityID":1111,"_Year":9999,"Year":9999,"_Period":99,"Period":99,"ActivityCode":"110-500-9999-99-1111-99","_ProductTypeID":110,"ProductTypeID":110,"_BranchID":500,"BranchID":500,"_ProductID":1111,"ProductID":1111,"_UnitID":99,"UnitID":99,"Modifiers":null},
                    "HasActiveMembership":true,
                    "JoinDate":"2017-02-11T00:00:00",
                    "AccessID":"123456",
                    "DenyAccess":true,
                    "DenyRecurringHold":false,
                    "HasFutureRecurringHold":false,
                    "DenySales":false,"Status":1,
                    "Deceased":false,
                    "Hide":false,
                    "AllowHide":false,
                    "HasImage":true,
                    "ModifyDate":"2019-12-01T12:55:27.007"
                }
}
                

QUERY PARAMETERS

RESPONSE

Get current member details

Required Permission: Sales-Members(Allow)

# Example get details for the single member associated with an access_token URL
/Sales/API/Member/Current
                

To get details for a single member associated with the current access_token you must make a GET request to the following URL:
/Sales/API/Member/Current

This end point does not require any query parameters. Instead, it gets the member associated with the current access_token that was gotten from a member login.

If the request is successful, a HTTP 200 response will be returned with a JSON object representing the member.

Result example :

{
  Member:{"MemberID":12345,
                    "FamilyID":0,
                    "MemberFamilyID":"12345-0",
                    "IsPrimary":true,
                    "ProfileID":null,
                    "Username":"12345",
                    "BranchID":500,
                    "MemberType":"I",
                    "Salutation":"",
                    "FirstName":"John",
                    "MiddleName":"",
                    "LastName":"Doe",
                    "Suffix":"",
                    "FullName":" John Doe",
                    "FamilyOrganizationName":"Doe Family",
                    "FirstLastName":"John Doe",
                    "FirstMiddleLastName":"John Doe",
                    "LastFirstName":"Doe, John",
                    "LastFirstMiddleName":"Doe, John",
                    "OrganizationName":"",
                    "DisplayName":"John Doe",
                    "Alias":"",
                    "HasAlias":false,
                    "OrganizationTypeID":0,
                    "Website":"",
                    "BirthDate":"1965-01-01T00:00:00",
                    "Age":55,
                    "Gender":"M",
                    "GenderName":"Male",
                    "PreferredAddressID":1,
                    "PreferredAddress":{"MemberID":12345,"AddressID":0,"AddressTypeID":"Home","Address1":"123 Example road","Address2":"","City":"Example city","State":"CA","Zip":"123456","ZipExt":null,"CountryID":"US","PositionName":"","OrganizationName":"","IsPreferred":false},
                    "HasPreferredAddress":true,
                    "PreferredPhoneID":1,
                    "PreferredPhone":{"MemberID":12345,"PhoneID":0,"PhoneTypeID":"Home","PhoneNumber":"555-555-5555","Extension":"","CountryID":"US","ReceiveTextAlerts":true,"PhoneWithExtension":"555-555-5555","IsPreferred":false},
                    "HasPreferredPhone":true,
                    "PreferredEmailID":1,
                    "PreferredEmail":{"MemberID":12345,"EmailID":0,"EmailTypeID":"Home","EmailAddress":"johndoe@gmail.com","IsPreferred":false},
                    "HasPreferredEmail":true,
                    "ActiveMembershipID":12345,
                    "Position":"",
                    "PositionName":null,
                    "Organization":null,
                    "OrganizationTypeName":null,
                    "ActiveMembership":{"RegistrationID":12345,"BranchName":"YMCA -Branch","ProductName":"Adult Membership (Ages 28-64)","StatusID":"A","BeginDate":"2018-05-12T00:00:00","EndDate":"9999-12-31T00:00:00","CancellationID":0,"MembershipClass":"I","MembershipLevel":"F","AllowAccess":true,"InCart":false,"BillingFrequency":null,"BillingFrequencyName":null,"RecurringHold":false,"RecurringHoldBeginDate":"0001-01-01T00:00:00","RecurringHoldEndDate":"0001-01-01T00:00:00","Url":"/Sales/MemberActivity?MemberID=12345","MemberID":12345,"FamilyID":0,"ActivityID":1111,"_Year":9999,"Year":9999,"_Period":99,"Period":99,"ActivityCode":"110-500-9999-99-1111-99","_ProductTypeID":110,"ProductTypeID":110,"_BranchID":500,"BranchID":500,"_ProductID":1111,"ProductID":1111,"_UnitID":99,"UnitID":99,"Modifiers":null},
                    "HasActiveMembership":true,
                    "JoinDate":"2017-02-11T00:00:00",
                    "AccessID":"123456",
                    "DenyAccess":true,
                    "DenyRecurringHold":false,
                    "HasFutureRecurringHold":false,
                    "DenySales":false,"Status":1,
                    "Deceased":false,
                    "Hide":false,
                    "AllowHide":false,
                    "HasImage":true,
                    "ModifyDate":"2019-12-01T12:55:27.007"
                }
}
                

QUERY PARAMETERS

RESPONSE

Get member registrations

Required Permission: Sales-Members(Allow), Sales-Activities(Allow)

# Example get registrations for a member url
/Sales/API/Member/Registrations?MemberID=12345
                

To get registrations for a member you must make a GET request to the following URL:
/Sales/API/Member/Registrations

{MemberID} is a required query string parameter if the {ForCurrentMember} query string parameter is false (0). If the {ForCurrentMember} query string parameter is true (1), then registrations will be shown for the member associated with the current access_token.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a property called 'registrations' containing a JSON array of registrations and a property called 'total' containing the total number of registrations.

Result example :

{
"total":1,
"registrations":[
{"MemberID":12345,
"FamilyID":0,
"FirstName":"John",
"MiddleName":"P",
"LastName":"Doe",
"BirthDate":"1985-01-01T00:00:00",
"Age":35,
"Gender":"M",
"PreferredAddress":{"MemberID":12345,
		"AddressID":0,
		"AddressTypeID":"Home",
		"Address1":"123 Street",
		"Address2":"",
		"City":"Akron City",
		"State":"AK",
		"Zip":"124",
		"ZipExt":null,
		"CountryID":"US"
		}
		"PreferredPhone":{"MemberID":12345,
		"PhoneID":0,
		"PhoneTypeID":"Home",
		"PhoneNumber":"555-555-5555",
		"Extension":"",
		"CountryID":"US",
		"ReceiveTextAlerts":true,
		"PhoneWithExtension":"555-555-5555"
		},
		"PreferredEmail":{"MemberID":12345,
		"EmailID":0,
		"EmailTypeID":"Home",
		"EmailAddress":"johndoe@test.com"
		},
		"ProductName":"Adult Membership (Ages 28-64)",
		"Dates":"08/27/2019 - 12/31/9999",
		"Days":"Sun to Sat",
		"ProductTypeID":110,
		"ProductTypeDescription":"110: Membership",
		"BranchID":100,
		"BranchName":"Branch YMCA",
		"ActivityCode":"110-100-9999-99-123456-99",
		"AccessStatus":"Deny",
		"Status":"Active",
		"CancellationReason":null,
		"RegistrationID":123456}
]}
                

QUERY PARAMETERS

RESPONSE

Check in member

Required Permission: Sales-Members(Allow), Member Check In(Allow)

# Example check a member into an access point url:
/Sales/API/Member/CheckIn?AccessPointID=18&MemberFamilyID=67314-0
                

To check a member into an access point you must make a GET request to the following URL:
/Sales/API/Member/CheckIn

{AccessPointID} is a required query string parameter. {MemberFamilyID} is a required query string parameter if {AccessID} is not passed.

If the request is successful, a HTTP 200 response will be returned with a JSON object with properties indicating if a member check in at a specified access point was successful.

Result example :

{
"IsGranted":true,
"Errors": []}
                

QUERY PARAMETERS

RESPONSE

Write to access log

Required Permission: Sales-Members(Allow), Member Check In(Allow)

# Example CURL to manually write to member access log
curl \
-X POST {baseUrl}/Sales/API/Member/WriteToAccessLog \
-H 'Authorization: Bearer {access_token}' \
-d 'AccessID=123456&AccessPointID=18&CheckInDateTime=01/15/2021 12:05 PM' 

                

To manually write to the member access log you must make a POST request to the following URL:
/Sales/API/Member/WriteToAccessLog

This endpoint will write to the access log but will not validate the access. It is used to allow outside sources to write to the check in log and assumes the check in was already validated and successful.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a boolean property called 'Success'.

Result example :

{"Success":true}
                

QUERY PARAMETERS

RESPONSE

Search member access

Required Permission: Sales-Members(Allow), Member Check In(Allow)

    # Example search member access url:
    /Sales/API/Member/SearchMemberAccess?BeginDate=08/01/2022&EndDate=08/20/2022&AccessPointID=1&MemberID=12345

To search member access(check ins/scans) for a particiular branch, access point, date range, and member, you must make a GET request to the following URL:
/Sales/API/Member/SearchMemberAccess

Each object in the JSON list returned contains properties for MemberID, FamilyID, MemberName, Gender, Age, AccessBranchID, AccessPointID, Day, Date, Time, Status, Message, ScannedByUser, AccessID, and Membership.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects with properties defining member access.

    Result example :

    [{"MemberID": 12345,
    "FamilyID": 0,
    "MemberName": "John Doe",
    "Gender": "M",
    "Age": 21,
    "AccessBranchID": 10,
    "AccessPointID": 1,
    "Day": "Tue",
    "Date": "Aug 9 2022",
    "Time": "3:57 PM",
    "CheckedInDateTime":"2021-04-02T16:49:57Z",
    "Status": "Allow",
    "Message": "Welcome",
    "ScannedByUser": "SGA",
    "AccessID": "123456",
    "Membership": "Two Adult Family"}]

QUERY PARAMETERS

RESPONSE

Get members allowed access

Required Permission: Sales-Members(Allow), Member Check In(Allow)

# Example get members allowed access url:
/Sales/API/Member/MembersAllowedAccess
                

To get a list defining members and what access points they can access you must make a GET request to the following URL:
/Sales/API/Member/MembersAllowedAccess

Each object in the JSON list returned contains properties for MemberID, FamilyID, AccessID, AccessPointID, and AccessBranchID to indicate if the member is allowed to access the AccessPointID and has an active registration. Every member that matches the product ranges is returned. This endpoint checks all access point requirements and all access points that match the FromAccessPointID and ToAccessPointID parameters. This will take a long time to return, especially if the parameters are left wide open.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects with properties indicating the members allowed access. Only members allowed access will be contained in the JSON array.

Result example :

[{"MemberID": 12345,
 "FamilyID": 0,
 "AccessID": "1511254",
 "AccessPointID":1,
 "AccessBranchID": 10},
 {"MemberID": 55445,
 "FamilyID": 0,
 "AccessID": "5252255",
  "AccessPointID":1,
 "AccessBranchID": 11}]

Result example when GroupByMember :

[{"MemberID":12345,"FamilyID":0,
"AccessID":"1511254","AccessPointIDs":[6,3,1,13,4,8,5,11,2]},
{"MemberID":55445,"FamilyID":0,
"AccessID":"5252255","AccessPointIDs":[8,5,11,3,6,1,4,13,2]}]
                

QUERY PARAMETERS

RESPONSE

Get members allowed access alternate

Required Permission: Sales-Members(Allow), Member Check In(Allow)

    # Example get members allowed access alternate url:
    /Sales/API/Member/MemberAlternateAccess

To get a list defining members that have access to a specific product you must make a GET request to the following URL:
/Sales/API/Member/MemberAlternateAccess

Each object in the JSON list returned contains properties for MemberID, FamilyID, AccessID, and AccessBranchID to indicate if the member is allowed to access the AccessBranchID and has an active registration. Every member that matches the product ranges is returned.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects with properties indicating the members allowed access. Only members allowed access will be contained in the JSON array.

Result example :

[{"MemberID": 12345,
 "FamilyID": 0,
 "AccessID": "1511254",
 "AccessBranchID": 10},
 {"MemberID": 55445,
 "FamilyID": 0,
 "AccessID": "5252255",
 "AccessBranchID": 11}]
                

QUERY PARAMETERS

RESPONSE

Get member image

Required Permission: Sales-Members(Allow)

    # Example get member image url:
    /Sales/API/Member/GetMemberImage?MemberID=1234&FamilyID=0&ModifiedOnOrAfter=01/15/2021 12:05 PM

To get a binary response representing the member's image you must make a GET request to the following URL:
/Sales/API/Member/GetMemberImage

The MemberID and FamilyID query string parameters are required.

If the request is successful, a HTTP 200 response will be returned with a binary response representing the member's image.

Result example :

{Binary Image}
                

QUERY PARAMETERS

RESPONSE

Update Nationwide Membership Person ID

Required Permission: Sales-Members(Allow)

# Example CURL to update Nationwide Membership Person ID
curl \
-X PUT {baseUrl}/Sales/API/Member/UpdateMemberPersonID \
-H 'Authorization: Bearer {access_token}' \
-d 'MemberPersonIdList=[{
         "PersonId":32522,
         "YUSABranchID":"98",
         "LocalMemberID":"1441978-0",
         "MemberFirstName":"Scott",
         "MemberLastName":"Armstrong",
         "MemberJoinDateOriginal":"32095",
         "MemberJoinDateCurrent":"",
         "MemberCreatedDateUtc":"",
         "MemberLastUpdatedDateUtc":""
      }]' 

                

To update the Nationwide Membership Person ID for a member you must make a PUT request to the following URL:
/Sales/API/Member/UpdateMemberPersonID

This endpoint will update the local member associated with the LocalMemberID and set the PersonID field to the passed PersonId JSON property.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a boolean property called 'HasErrors', integer property called 'NbrOfMembersUpdated', and string array property called 'ErrorMessages'.

Result example :

{"HasErrors":false, "NbrOfMembersUpdated": 1, "ErrorMessages": []}
                

QUERY PARAMETERS

RESPONSE

Recover member password

# Example CURL to send recover password email
curl \
-X POST {baseUrl}/Sales/API/Member/RecoverPassword \
-H 'Authorization: Bearer {access_token}' \
-d 'Email=johndoe@gmail.com' 

                

To get send a recover password email to a member you must make a POST request to the following URL:
/Sales/API/Member/RecoverPassword

{Email} is a required query string parameter. The email must match a member in the system for the email to send successfully.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a boolean property called 'success'.

Result example :

{"success":true}
                

QUERY PARAMETERS

RESPONSE

Change member password

# Example CURL to change a member password
curl \
-X POST {baseUrl}/Sales/API/Member/ChangePassword \
-H 'Authorization: Bearer {access_token}' \
-d 'client_id={client_id}&client_secret={client_secret}&Email=johndoe@gmail.com&OldPassword=123&NewPassword=12345&ConfirmNewPassword=12345' 

                

To get change a member's password you must make a POST request to the following URL:
/Sales/API/Member/ChangePassword

{client_id}, {client_secret}, {Email}, {OldPassword}, {NewPassword}, and {ConfirmNewPassword} are required POST parameters.

This end point will change a member's password and then email the member indicating that their password has been changed.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a boolean property called 'success'.

Result example :

{"success":true}
                

QUERY PARAMETERS

RESPONSE

Get member details for login

# Example CURL to get member details for login
curl \
-X POST {baseUrl}/Sales/API/Member/GetMemberDetailsForLogin \
-H 'Authorization: Bearer {access_token}' \
-d 'client_id={client_id}&client_secret={client_secret}&Email=johndoe@gmail.com&Password=1234' 

                

To get member details for a login you must make a POST request to the following URL:
/Sales/API/Member/GetMemberDetailsForLogin

{client_id}, {client_secret}, {Email}, and {Password} are required POST parameters.

This end point will validate the login and return a JSON object representing the member details and if the login was successful.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a property of 'MemberDetails' representing a JSON object with the member details associated with the login and a boolean property of 'Authorized' representing if the login was successful.

Result example :

                         {"Authorized":true,
"MemberDetails":{"MemberID":68145,"FamilyID":0,"MemberFamilyID":"68145-0",
"IsPrimary":true,"BranchID":0,"MemberType":"I","Salutation":"","FirstName":"Test","MiddleName":"","LastName":"Last",
"Suffix":"","FullName":" Test Last","FamilyOrganizationName":"Last Family","FirstLastName":"Test Last",
"FirstMiddleLastName":"Test Last","LastFirstName":"Last, Test",
"LastFirstMiddleName":"Last, Test","OrganizationName":"","DisplayName":"Test Last",
"Alias":"","HasAlias":false,"OrganizationTypeID":0,"Website":"","BirthDate":"1980-05-21T00:00:00",
"Age":40,"AgeInMonths":486,"Gender":"M",
"PreferredAddressID":0,"PreferredAddress":null,"HasPreferredAddress":false,"PreferredPhoneID":1,
"PreferredPhone":{"MemberID":68145,"PhoneID":0,"PhoneTypeID":"Mobile","PhoneNumber":"123-456-9622","Extension":"","CountryID":"US","ReceiveTextAlerts":true,"PhoneWithExtension":"123-456-9622","_UsedBy":[],"UsedBy":[],"IsPreferred":false},
"HasPreferredPhone":true,"PreferredEmailID":1,
"PreferredEmail":{"MemberID":68145,"EmailID":0,"EmailTypeID":"Home","EmailAddress":"testemail@gmail.com","IsPreferred":false,"ReceiveEmails":false}, "HasPreferredEmail":true,"ActiveMembershipID":0,"Position":"","PositionName":null,
"Organization":null,"OrganizationTypeName":null,"ActiveMembership":{"RegistrationID":104949,"BranchName":"YMCA Branch","ProductName":"Adult Membership (27-64 yrs)","StatusID":"A","BeginDate":"2020-12-02T00:00:00","EndDate":"9999-12-31T00:00:00","CancellationID":0,"MembershipClass":"I","MembershipLevel":"F","AllowAccess":true,"InCart":true,"BillingFrequency":"M","BillingFrequencyName":"Monthly","RecurringHold":false,"RecurringHoldBeginDate":"0001-01-01T00:00:00","RecurringHoldEndDate":"0001-01-01T00:00:00","MemberID":68145,"FamilyID":0,"ActivityID":13289,"_Year":9999,"Year":9999,"_Period":99,"Period":99,"ActivityCode":"110-100-9999-99-11130-99","_ProductTypeID":110,"ProductTypeID":110,"_BranchID":100,"BranchID":100,"_ProductID":11130,"ProductID":11130,"_UnitID":99,"UnitID":99},"HasActiveMembership":true,
"JoinDate":"0001-01-01T00:00:00","AccessID":null,"DenyAccess":true,"DenyRecurringHold":false,"HasFutureRecurringHold":false,
"DenyAccessToUse":true,"DenySales":false,"Status":1,"Deceased":false,"Hide":false,"AllowHide":false,
"ModifyDate":"2020-12-02T08:30:57.447","Addresses":[],
"Phones":[{"MemberID":68145,"PhoneID":1,"PhoneTypeID":"Mobile","PhoneNumber":"123-456-9622","Extension":"","CountryID":"US","ReceiveTextAlerts":true,"PhoneWithExtension":"123-456-9622","_UsedBy":["Test Last"],
"UsedBy":["Test Last"],"IsPreferred":true}],"Emails":[{"UsedBy":[{"MemberID":68145,"FamilyID":0,"EmailID":1,"FirstLastName":"Test Last"}],"MemberID":68145,"EmailID":1,"EmailTypeID":"Home","EmailAddress":"testemail@gmail.com","IsPreferred":true,"ReceiveEmails":true}],"MiscInformationList":[],"StatusComment":"","OverrideHouseholdMembershipCount":false,"OverrideHouseholdMembershipCountComment":"","Tag":null,"NbrOfAttachments":0}}
                

POST PARAMETERS

RESPONSE

Authorize Member

# Example CURL to validate and authorize a member login
curl \
-X POST {baseUrl}/Sales/API/Member/AuthorizeMember \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-d '{"associationNumber": "1234", "loginId": "testemail@email.com"}' 

                

To authorize a member login you must make a POST request to the following URL:
/Sales/API/Member/AuthorizeMember

The body of the request should be a JSON object with the properties of associationNumber and loginId. The header of the request must contain the authorization bearer token gotten from the OAuth2 member login get access token for user process.

This end point will validate the login and return a JSON array with one JSON object representing the member details if the login was successful.

If the request is successful, a HTTP 200 response will be returned with a JSON array with one JSON object representing the member details associated with the login.

Result example :

                       [
{
 "associationNumber": "1234",
 "localMemberId": "017728-66",
 "barcode": "138138",
 "email": "testemail@email.com",
 "firstName": "YMCA",
 "lastName": "YMCA",
 "gender": "Male",
 "dob": "2020-06-01",
 "Alias": "",
 "status": "Active"
}
]
                

JSON POST PARAMETERS

RESPONSE

Search for products

Required Permission: Sales-Cart(Allow)

    # Example Search products URL
    /Sales/API/Product/Search?ProductTypeID=651&BranchID=400&ProductID=65491&Year=2020&IncludePrices=1

To search products you must make a GET request to the following URL:
/Sales/API/Product/Search

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing products.

Result example :
                         [
                    {"ActivityID":12345,
                    "ActivityCode":"651-400-2020-99-65491-09",
                    "Status":"Available",
                    "DaysOffered":"Mon to Fri",
                    "BeginDate":"01/01/2020",
                    "EndDate":"07/01/2020",
                    "Time":"3:30 PM - 5:30 PM",
                    "Prices":[{"PriceID":24,"PriceName":"Facility Member",
                    "Frequency":"One Time","Amount":45.00,
                    "Display":"B","Variable":"N","Duration":"E",
                    "DayPrice1":0.00,"DayPrice2":0.00,"DayPrice3":0.00,"DayPrice4":0.00,"DayPrice5":0.00,"DayPrice6":0.00}],
                    "Ages":"5 to 15",
                    "Gender":"Any",
                    "Location":"",
                    "Category":null,
                    "MembershipLevel":"No Membership Required",
                    "ProductTypeID":651,
                    "ProductTypeName":"Product",
                    "BranchID":400,
                    "BranchName":"YMCA Branch Center",
                    "ProductID":12345,
                    "ProductName":"Late Pick-up",
                    "UnitID":9,
                    "Year":2020,
                    "Period":99,
                    "Description":"3:30 PM-5:30PM.",
                    "Requirements":null,
                    "Images":"/Meta/Item/GetImage?ImageID=58",
                    "CompleteUrl":"https://membersite.sgasoftware.com/Sales/Product/Details?ActivityID=12345",
                    "FullMemberBrowseBeginDate":"07/09/2024 12:00 AM","FullMemberBrowseEndDate":"07/09/2024 11:59 PM","ProgramMemberBrowseBeginDate":"07/09/2024 12:00 AM",
                    "ProgramMemberBrowseEndDate":"07/09/2024 11:59 PM","NonMemberBrowseBeginDate":"07/09/2024 12:00 AM","NonMemberBrowseEndDate":"07/09/2024 11:59 PM",
                    "StaffBrowseBeginDate":"07/09/2024 12:00 AM","StaffBrowseEndDate":"07/09/2024 11:59 PM","OverrideRegistrationDates":"false",
                    "FullMemberRegistrationBeginDate":"07/09/2024 12:00 AM","FullMemberRegistrationEndDate":"07/09/2024 11:59 PM","ProgramMemberRegistrationBeginDate":"07/09/2024 12:00 AM",
                    "ProgramMemberRegistrationEndDate":"07/09/2024 11:59 PM","NonMemberRegistrationBeginDate":"07/09/2024 12:00 AM","NonMemberRegistrationEndDate":"07/09/2024 11:59 PM",
                    "StaffRegistrationBeginDate":"07/09/2024 12:00 AM","StaffRegistrationEndDate":"07/09/2024 11:59 PM", "AllowBrowse": "Staff Only", "AllowRegistration": "Staff Only"}
                    ]
                

QUERY PARAMETERS

RESPONSE

Prices JSON PROPERTIES

Get product details

Required Permission: Sales-Cart(Allow)

    # Example URL to get details for a single product
    /Sales/API/Product/Details?ActivityID=12345

To get details for a single product you must make a GET request to the following URL:
/Sales/API/Product/Details

If the request is successful, a HTTP 200 response will be returned with a JSON object representing the product.

Result example :

                          {
                    "ActivityID":12345,
                    "ActivityCode":"651-400-2020-99-65491-09",
                    "Status":"Available",
                    "DaysOffered":"Mon to Fri",
                    "BeginDate":"01/01/2020",
                    "EndDate":"07/01/2020",
                    "Time":"3:30 PM - 5:30 PM",
                    "Price":"One Time $85 to $95",
                    "Ages":"5 to 15",
                    "Gender":"Any",
                    "Location":"",
                    "Category":null,
                    "MembershipLevel":"No Membership Required",
                    "ProductTypeID":651,
                    "ProductTypeName":"Product",
                    "BranchID":400,
                    "BranchName":"YMCA Branch Center",
                    "ProductID":12345,
                    "ProductName":"Late Pick-up",
                    "UnitID":9,
                    "Year":2020,
                    "Period":99,
                    "Description":"3:30 PM-5:30PM.",
                    "Requirements":null,
                    "Images":"/Meta/Item/GetImage?ImageID=58",
                    "CompleteUrl":"https://membersite.sgasoftware.com/Sales/Product/Details?ActivityID=12345"
                    }
                

QUERY PARAMETERS

RESPONSE

Get product registrations

Required Permission: Sales-Members(Allow), Sales-Activities(Allow)

    # Example get registrations for a product url
    /Sales/API/Product/Registrations?ProductTypeID=110

To get registrations for a product you must make a GET request to the following URL:
/Sales/API/Product/Registrations

Registrations can be gotten for just a product type by using the ProductTypeID query string parameter or an activity code by using the ActivityCode parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a property called 'registrations' containing a JSON array of registrations and a property called 'total' containing the total number of registrations.

Result example :

{
"total":1,
"registrations":[
{"MemberID":12345,
"FamilyID":0,
"FirstName":"John",
"MiddleName":"P",
"LastName":"Doe",
"BirthDate":"1985-01-01T00:00:00",
"Age":35,
"Gender":"M",
"PreferredAddress":{"MemberID":12345,
		"AddressID":0,
		"AddressTypeID":"Home",
		"Address1":"123 Street",
		"Address2":"",
		"City":"Akron City",
		"State":"AK",
		"Zip":"124",
		"ZipExt":null,
		"CountryID":"US"
		}
		"PreferredPhone":{"MemberID":12345,
		"PhoneID":0,
		"PhoneTypeID":"Home",
		"PhoneNumber":"555-555-5555",
		"Extension":"",
		"CountryID":"US",
		"ReceiveTextAlerts":true,
		"PhoneWithExtension":"555-555-5555"
		},
		"PreferredEmail":{"MemberID":12345,
		"EmailID":0,
		"EmailTypeID":"Home",
		"EmailAddress":"johndoe@test.com"
		},
		"ProductName":"Adult Membership (Ages 28-64)",
		"Dates":"08/27/2019 - 12/31/9999",
		"Days":"Sun to Sat",
		"ProductTypeID":110,
		"ProductTypeDescription":"110: Membership",
		"BranchID":100,
		"BranchName":"Branch YMCA",
		"ActivityCode":"110-100-9999-99-123456-99",
		"AccessStatus":"Deny",
		"Status":"Active",
		"CancellationReason":null,
		"RegistrationID":123456}
]}
                

QUERY PARAMETERS

RESPONSE

Get product roster

Required Permission: Sales-Members(Allow), Sales-Activities(Allow)

    # Example get roster for a product url
    /Sales/API/Product/Roster?ProductTypeID=300&MemberID=12345

To get a roster you must make a GET request to the following URL:
/Sales/API/Product/Roster

ProductTypeID is a required query string parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a property called 'rosters' containing a JSON array of roster objects and a property called 'total' containing the total number of roster objects.

Result example :

{"total":1,"rosters":[
{"MemberID":12345,
"FamilyID":0,
"FirstName":"John",
"MiddleName":"P",
"LastName":"Doe",
"Phone":"555-555-5555",
"GroupName":null,
"AssignmentType":"Unassigned",
"StaffTypeName":null,
"Email":"johndoe@test.com",
"ProductID":11680,
"ProductName":"Adult Beginner Swim Lessons",
"Dates":"07/01/2019 - 09/29/2019",
"Days":"Thu",
"GroupCategory":null,
"GroupSubCategory":null,
"Age":35,
"BirthDate":"1985-01-01T00:00:00",
"City":"Akron City",
"ProductTypeID":300,
"BranchID":400,
"BranchName":"YMCA Branch Center",
"Year":"9999",
"Period":"99",
"UnitID":"99"}
]}
                

QUERY PARAMETERS

RESPONSE

Search branches

Required Permission: Sales-Branches(Allow)

# Example search branches url
/Sales/API/Branch
                

To search branches you must make a GET request to the following URL:
/Sales/API/Branch

BranchID is an optional query string parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON array of branch objects.

Result example :

[{"BranchID":100,
                    "Name":"Branch at YMCA",
                    "Abbreviation":"BR",
                    "Address1":"123 Road Street",
                    "Address2":"",
                    "City":"Akron",
                    "State":"AK",
                    "Zip":"12345",
                    "Contact":"",
                    "Phone":"123-456-7891",
                    "PhoneExtension":"",                         
                    "Deleted":false,
                    "LoginLevel": "Public, Member & Staff",
                    "SortOrder": 1,
                    "AlternateBranchID": "3337"}
]
                

QUERY PARAMETERS

RESPONSE

Set Alternate Branch

Required Permission: Sales-Branches(Allow)

    # Example CURL to set an Alternate Branch ID
    curl \
    -X POST {baseUrl}/Sales/API/Branch/UpdateAlternateBranchID \
    -H 'Authorization: Bearer {access_token}' \
    -d 'BranchID=10&AlternateBranchID=1234'

To set an alternate branch ID for a branch you must make a POST request to the following URL:
/Sales/API/Branch/UpdateAlternateBranchID

{BranchID} and {AlternateBranchID} are required POST parameters.

This end point will update the AlternateBranchID for the branch associated with the passed BranchID.

If the request is successful, a HTTP 200 response will be returned with a JSON object with a boolean property called 'success'.

Result example :

{"success":true}
                

QUERY PARAMETERS

RESPONSE

Get company information

Required Permission: SignOn-Options(Modify)

    # Example get company information url
    /Sales/API/Branch/GetCompanyInformation

To get company information you must make a GET request to the following URL:
/Sales/API/Branch/GetCompanyInformation

If the request is successful, a HTTP 200 response will be returned with a JSON object representing company information.

Result example :

{"CompanyName":"YMCA",
                    "CompanyAddress1":"123 Road Street",
                    "CompanyAddress2":"",
                    "CompanyCity":"Akron",
                    "CompanyState":"AK",
                    "CompanyZip":"12345",
                    "CompanyPhone":"123-456-7891",
                    "CompanyEmail":"email@Email.com"}

                

RESPONSE

Get Branch capacity

Required Permission: SignOn-Options(Modify)

    # Example get branch capacity url
    /Sales/API/Branch/GetBranchCapacity

To get branch capacity information you must make a GET request to the following URL:
/Sales/API/Branch/GetBranchCapacity

If the request is successful, a HTTP 200 response will be returned with a JSON array representing capacity information.

Result example :

[{"BranchID": "010", "BranchName": "Association Office", "CurrentCapacity": 25, "MaxCapacity": 50, "PercentFull": 50,
"Rooms": [{"AccessPointID": 1, "AccessPointName": "Childcare room", "CurrentCapacity": 5, "MaxCapacity": 10, "PercentFull": 50}]
}]

                

QUERY PARAMETERS

RESPONSE

Search product names

Required Permission: Sales-Products(Allow)

# Example search product names url
/Sales/API/ProductSettings?ProductTypeID=110
                

To search product names you must make a GET request to the following URL:
/Sales/API/ProductSettings

ProductTypeID and all other query string parameters are optional.

If the request is successful, a HTTP 200 response will be returned with a JSON array of product name objects.

Result example :

                [{"ProductNameID":3766, 
                    "ProductTypeID": 110,
                    "ProductTypeName":"Converted Balances & Credits",
                    "ProductID":"99998",
                    "ProductName":"Converted Credit","CategoryName":null,
                    "SubCategoryName":null,
                    "Tags":"","MembershipClass":" ","MembershipLevel":" ",
                    "AllowAccess":"No",
                    "AllowNationwideMembership":"No"},
                    {"ProductNameID":3767,
                    "ProductTypeID": 110,
                    "ProductTypeName":"Converted Balances & Credits",
                    "ProductID":"99999",
                    "ProductName":"Converted Balance Owed","CategoryName":null,
                    "SubCategoryName":null,
                    "Tags":"","MembershipClass":" ","MembershipLevel":" ",
                    "AllowAccess":"No",
                    "AllowNationwideMembership":"No"}
                ]
                

QUERY PARAMETERS

RESPONSE

Get product name details

Required Permission: Sales-Products(Allow)

# Example get product name details url
/Sales/API/ProductSettings/3766
                

To get details for a single product name you must make a GET request to the following URL:
/Sales/API/ProductSettings/{ProductNameID}

{ProductNameID} is a required route parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON object representing the product name.

Result example :

                   {"ProductNameID":3766, 
                    "ProductTypeID": 110,
                    "ProductTypeName":"Converted Balances & Credits",
                    "ProductID":"99998",
                    "ProductName":"Converted Credit","CategoryName":null,
                    "SubCategoryName":null,
                    "Tags":"","MembershipClass":" ","MembershipLevel":" ",
                    "AllowAccess":"No",
                    "AllowNationwideMembership":"No"}
                

QUERY PARAMETERS

RESPONSE

Search product categories

Required Permission: Sales-Product Categories(Allow)

# Example search product categories url
/Sales/API/ProductSettings/SearchCategories?ProductTypeID=110
                

To search product categories you must make a GET request to the following URL:
/Sales/API/ProductSettings/SearchCategories

ProductTypeID is an optional query string parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON array of product category objects.

Result example :

               [{"CategoryID": 1, "ProductTypeID":110,"ProductTypeName":"Membership",
                    "LoginLevel":"Staff, Member, And Public",
                    "Name":"Membership Adult","SubCategoryList":null},
                {"CategoryID": 2, "ProductTypeID":110,"ProductTypeName":"Membership",
                    "LoginLevel":"Staff, Member, And Public",
                    "Name":"Membership Household","SubCategoryList":null}
               ]
                

QUERY PARAMETERS

RESPONSE

Search product types

Required Permission: Sales-Product Types(Allow)

# Example search product types url
/Sales/API/ProductSettings/SearchProductTypes
                

To search product types you must make a GET request to the following URL:
/Sales/API/ProductSettings/SearchProductTypes

Product types are the highest level of a product. These determine how a product behaves and what all features and fields it includes.

If the request is successful, a HTTP 200 response will be returned with a JSON array of product type objects.

Result example :

              [{"ProductTypeID":110,"Name":"Membership",
                    "LoginLevels":"Public, Member & Staff"},
                    {"ProductTypeID":150,"Name":"Guest Passes & Tours",
                    "LoginLevels":"Staff Only"},
                    {"ProductTypeID":170,"Name":"Joiners Fees",
                    "LoginLevels":"Public, Member & Staff"},
                    {"ProductTypeID":200,"Name":"Fitness",
                    "LoginLevels":"Public, Member & Staff"}
              ]
                

QUERY PARAMETERS

RESPONSE

Search product periods

Required Permission: Sales-Product Periods(Allow)

# Example search product types url
/Sales/API/ProductSettings/SearchProductPeriods?ProductTypeID=301&FromYear=2020&ToYear=9999&FromPeriod=0&ToPeriod=99
                

To search product types you must make a GET request to the following URL:
/Sales/API/ProductSettings/SearchProductPeriods

Product periods specify a particular season within the year. They are set for each Product Type and Branch and define the dates when members can register for products.

If the request is successful, a HTTP 200 response will be returned with a JSON array of product period objects.

Result example :

             [{"ProductTypeID":301,
               "ProductTypeName":"Swim: One Time Fee's",
               "BranchID":100,"BranchName":"Quincy YMCA",
               "Year":9999,"Period":99,"PeriodName":"Forever",
               "DefaultProductBeginDate":"01/01/0001",
                "DefaultProductEndDate":"12/31/9999",
                "FullMemberBeginDate":"01/01/1900",
                "FullMemberEndDate":"12/31/9999",
                "ProgramMemberBeginDate":"01/01/1900",
                "ProgramMemberEndDate":"12/31/9999",
                "NonMemberBeginDate":"01/01/1900",
                "NonMemberEndDate":"12/31/9999",
                "StaffBeginDate":"01/01/1900",
                "StaffEndDate":"12/31/9999"}
              ]
                

QUERY PARAMETERS

RESPONSE

Search for calendar events

Required Permission: Sales-Calendar Events(Modify)

# Example Search calendar events URL
/Sales/API/CalendarEvent?BeginDate=09/01/2020&EndDate=09/07/2020&LocationID=12

                

To search calendar events you must make a GET request to the following URL:
/Sales/API/CalendarEvent

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar events. Each object in the array, will have properties for hour and the events that occur on that hour.

    Result example :
    [{"Hour":8,"Events":[{"EventID":14341,
    "Name":"Downtown Pool Lane 1","Description":"Lane reservation may be used for lap swim or self-led water exercise routines.","BranchID":10,"BeginDate":"2020-09-02T04:45:00","EndDate":"2020-09-02T05:45:00",
    "EventDate":"2020-09-02T04:45:00","IsAllDay":false,
    "IsRecurring":false,"RecurringPattern":"","NotificationFrequency":"","NotificationFrequencyNumber":0,"NotificationStatus":0,
    "CategoryID":2,"LocationID":6,"InstructorID":6,"BranchName":"YMCA of Greater Somewhere","CategoryName":"Lap Swim","LocationName":"Lap Pool",
    "InstructorName":"Self-Guided","HexColor":"","TimeString":"4:45 am - 5:45 am","BeginTimeMilitary":"04:45",
    "EndTimeMilitary":"05:45","TimeElapsed":"(1 hour)","DaysOfWeekString":"Wed","ReservationsEnabled":true,
    "ShowReserveButtonsBeforeReservationsBegin":false,"WaitlistEnabled":false,"WaitlistOpenings":0,"AutoAddFromWaitlist":false,
    "SendWaitlistNotification":false,"NbrOfAttendees":0,"Openings":1,"TimeBeforeEventReservationsBegin":864000000000,"TimeBeforeEventReservationsEnd":36000000000,
    "MinimumAge":9,"MaximumAge":255,"MembershipLevel":"F","Reservations":null,"Waitlists":null,"Attendees":null,"RsvpBeginDateUtc":"2020-09-01T08:45:00Z",
    "RsvpBeginDateFacility":"2020-09-01T04:45:00","RsvpEndDateUtc":"2020-09-02T07:45:00Z","RsvpEndDateFacility":"2020-09-02T03:45:00"}]},
    {"Hour":9,"Events":[{"EventID":895,
    "Name":"Aqua Fit","Description":"","BranchID":100,"BeginDate":"2020-09-04T09:00:00","EndDate":"2020-09-04T10:00:00",
    "IsAllDay":false,
    "IsRecurring":true,"RecurringPattern":"FREQ=WEEKLY;BYDAY=FR;",
    "CategoryID":6,"LocationID":12,"InstructorID":74,"BranchName":"Branch YMCA","CategoryName":"Water",
    "LocationName":"Main Pool","InstructorName":"Joe N.","DateString":"Friday, September 4 2020",
    "TimeString":"9:00 am - 10:00 am","BeginTimeMilitary":"09:00","EndTimeMilitary":"10:00","TimeElapsed":"(1 hour)",
    "DaysOfWeekString":"Fri","ReservationsEnabled":false,"Openings":0,"TimeBeforeEventReservationsBegin":null,"TimeBeforeEventReservationsEnd":null,
    "ShowReserveButtonsBeforeReservationsBegin":false,"WaitlistEnabled":false,"WaitlistOpenings":0,"AutoAddFromWaitlist":false,
    "MinimumAge":0,"MaximumAge":0,"MembershipLevel":"E","Reservations":null,"ReservationsBeginDateJson":{"Year":1,"Month":1,"Day":1,"Hour":5,"Minute":0,"Second":0,"IsUTC":1},
    "ReservationsEndDateJson":{"Year":9999,"Month":12,"Day":31,"Hour":23,"Minute":59,"Second":59,"IsUTC":1}}]}]

QUERY PARAMETERS

RESPONSE EVENT PROPERTIES

Search for events in class schedule format

Required Permission: Sales-Calendar Events(Modify)

# Example Search calendar events in class schedule format URL
/Sales/API/CalendarEvent/SearchClassScheduleEvents?BeginDate=09/01/2020&EndDate=09/07/2020&LocationID=12

                

To search calendar events in class schedule format you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchClassScheduleEvents

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar events in class schedule format.

    Result example :
    [{"title":"All Ages - Teaching Pool","recurType":"",
    "eventSeriesInstanceCount":0,"eventSeriesStartDate":"",
    "status":"Confirmed","createdDate":"2020-09-03T10:30:00Z","lastUpdatedDate":"2020-09-03T10:30:00Z",
    "meetingLink":"","equipment":"","hostName":"Self-Guided",
    "eventSeriesId":14614,"level":"",
    "category":"Open Swim","eventImage":"","startDate":"2020-09-03T10:30:00Z",
    "endDate":"2020-09-03T11:15:00Z","location":"Teaching Pool",
    "BranchName":"Branch YMCA","LocationName":"Teaching Pool",
    "ReservationsEnabled":true,"WaitlistEnabled":true,"WaitlistOpenings":5,
    "NbrOfAttendees":0,"Openings":10,"MinimumAge":12,"MaximumAge":99, "Cancelled": false,
    "NbrOfReservations":2,"NbrOfWaitlists":0,,"ReservationsBeginDateJson":{"Year":1,"Month":1,"Day":1,"Hour":5,"Minute":0,"Second":0,"IsUTC":1},
    "ReservationsEndDateJson":{"Year":9999,"Month":12,"Day":31,"Hour":23,"Minute":59,"Second":59,"IsUTC":1}}]}}]

QUERY PARAMETERS

RESPONSE EVENT PROPERTIES

Search for waitlists and reservations

Required Permission: Sales-Calendar Events(Modify)

# Example Search calendar waitlists and reservations URL
/Sales/API/CalendarEvent/SearchWaitlistsAndReservations?BeginDate=09/01/2020&EndDate=09/07/2020&MemberID=123&FamilyID=-1

                

To search calendar waitlists and reservations you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchWaitlistsAndReservations

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar events that the passed member has waitlists and reservations for.

    Result example :
    [{"title":"All Ages - Teaching Pool","recurType":"",
    "eventSeriesInstanceCount":0,"eventSeriesStartDate":"",
    "status":"Confirmed","createdDate":"2020-09-03T10:30:00Z","lastUpdatedDate":"2020-09-03T10:30:00Z",
    "meetingLink":"","equipment":"","hostName":"Self-Guided",
    "eventSeriesId":14614,"level":"",
    "category":"Open Swim","eventImage":"","startDate":"2020-09-03T10:30:00Z",
    "endDate":"2020-09-03T11:15:00Z","location":"Teaching Pool",
    "BranchName":"Branch YMCA","LocationName":"Teaching Pool",
    "ReservationsEnabled":true,"WaitlistEnabled":true,"WaitlistOpenings":5,
    "NbrOfAttendees":0,"Openings":10,"MinimumAge":12,"MaximumAge":99,
    "NbrOfReservations":2,"NbrOfWaitlists":0,,"ReservationsBeginDateJson":{"Year":1,"Month":1,"Day":1,"Hour":5,"Minute":0,"Second":0,"IsUTC":1},
    "ReservationsEndDateJson":{"Year":9999,"Month":12,"Day":31,"Hour":23,"Minute":59,"Second":59,"IsUTC":1}, "IsReservation": true, "IsWaitlist": false, "MemberID": 123, "FamilyID": 1, "IsCancelled": false}]

QUERY PARAMETERS

RESPONSE EVENT PROPERTIES

Import calendar events

Required Permission: Sales-Calendar Events(Modify)

# Example CURL to import calendar events
curl \
-X POST {baseUrl}/Sales/API/CalendarEvent/ImportEvents \
-H 'Authorization: Bearer {access_token}' \
-d 'Events=[{"EventID":0, "Name": "Test event import not recurring", "Description": "Import 1", "IsAllDay": false, "RecurringPattern": "", "BeginDate": "09/01/2020", "EndDate": "09/01/2020", "MilitaryBeginTime": "3:00","MilitaryEndTime": "5:00", "BranchID": 100, "CategoryID": 0, "LocationID": 0, "InstructorID": 0, "Category": "", "Location": "", "Instructor": "","ReservationsEnabled": false, "Openings": 0, "TimeBeforeEventReservationsBegin": 0,"TimeBeforeEventReservationsEnd": 0, "MinimumAge": 0, "MaximumAge": 200, "MembershipLevel": "E"}]' 

                

To import calendar events you must make a POST request to the following URL:
/Sales/API/CalendarEvent/ImportEvents

The request must contain a POST parameter of Events that represents a JSON array of events to import. Events that already exist for the EventID will be updated. Instructors, Categories, and Locations that do not exist will be created.

If the request is successful, a HTTP 200 response will be returned with a JSON object containing properties for NumberOfEventsUpdated and NumberOfEventsCreated.

Example JSON of Events to pass to Sales/API/CalendarEvent/ImportEvents to create:
[
{"EventID":0, "Name": "Test event import not recurring", "Description": "Import 1", "IsAllDay": false, "RecurringPattern": "", "BeginDate": "09/01/2020", "EndDate": "09/01/2020", "MilitaryBeginTime": "3:00",
"MilitaryEndTime": "5:00", "BranchID": 100, "CategoryID": 0, "LocationID": 0, "InstructorID": 0, "Category": "", "Location": "", "Instructor": "",
"ReservationsEnabled": false, "Openings": 0, "TimeBeforeEventReservationsBegin": 0,
"TimeBeforeEventReservationsEnd": 0, "MinimumAge": 0, "MaximumAge": 200, "MembershipLevel": "E"},

{"EventID":0, "Name": "Test event import recurring", "Description": "Import 2 recurring weekly on Tuesdays and Thursdays", "IsAllDay": false, "RecurringPattern": "FREQ=WEEKLY;BYDAY=TU,TH;",
 "BeginDate": "09/15/2020", "EndDate": "10/19/2020", "MilitaryBeginTime": "4:00",
"MilitaryEndTime": "6:00", "BranchID": 100, "CategoryID": 0, "LocationID": 0, "InstructorID": 0, "Category": "", "Location": "", "Instructor": "",
 "ReservationsEnabled": false, "Openings": 0, "TimeBeforeEventReservationsBegin": 0,
"TimeBeforeEventReservationsEnd": 0, "MinimumAge": 0, "MaximumAge": 200, "MembershipLevel": "E"},

{"EventID":0, "Name": "Test event import create category and location for branch", "Description": "Import 3 create category and location for branch if they do not exist", "IsAllDay": false, "RecurringPattern": "",
 "BeginDate": "09/02/2020", "EndDate": "09/02/2020", "MilitaryBeginTime": "2:00",
"MilitaryEndTime": "5:00", "BranchID": 100, "CategoryID": 0, "LocationID": 0, "InstructorID": 0, "Category": "Category name to create", "Location": "Location name to create", "Instructor": "",
 "ReservationsEnabled": false, "Openings": 0, "TimeBeforeEventReservationsBegin": 0,
"TimeBeforeEventReservationsEnd": 0, "MinimumAge": 0, "MaximumAge": 200, "MembershipLevel": "E"},

{"EventID":0, "Name": "Test event import with reservations", "Description": "Import 4 with reservations only for non recurring events", "IsAllDay": false, "RecurringPattern": "",
 "BeginDate": "09/03/2020", "EndDate": "09/03/2020", "MilitaryBeginTime": "3:00",
"MilitaryEndTime": "16:00", "BranchID": 100, "CategoryID": 0, "LocationID": 0, "InstructorID": 0, "Category": "", "Location": "", "Instructor": "",
 "ReservationsEnabled": true, "Openings": 2, "TimeBeforeEventReservationsBegin": 86400,
"TimeBeforeEventReservationsEnd": 900, "MinimumAge": 0, "MaximumAge": 200, "MembershipLevel": "E"}
]

Response:
{"NumberOfEventsUpdated":0,"NumberOfEventsCreated":4}
                

POST PARAMETERS

IMPORT EVENT PROPERTIES

Search for calendar event reservations

Required Permission: Sales-Calendar Events(Allow)

# Example Search calendar event reservations URL
/Sales/API/CalendarEvent/SearchReservations?EventID=123

                

To search calendar event reservations you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchReservations

{EventID} is a required query string parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar event reservations.

Result example :
                 [{"EventID":123,
                    "MemberID":1111,
                    "FamilyID":0},
                    {"EventID":123,
                    "MemberID":1234,
                    "FamilyID":1}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Search for calendar event waitlists

Required Permission: Sales-Calendar Events(Allow)

    # Example Search calendar event waitlists URL
    /Sales/API/CalendarEvent/SearchWaitLists?EventID=123

To search calendar event waitlists you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchWaitLists

{EventID} is a required query string parameter.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar event waitlists. The waitlists are ordered by CreateDateTime and the oldest waitlist will be first in the returned array.

Result example :
                 [{"EventID":123,
                    "MemberID":1111,
                    "FamilyID":0},
                    {"EventID":123,
                    "MemberID":1234,
                    "FamilyID":1}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Check member event eligibility

Required Permission: Sales-Calendar Events(Modify)

# Example Check if member family is eligible to make a reservation for an event URL
/Sales/API/CalendarEvent/CheckEligibility?EventID=1&MemberID=1234

                

To check if a member is eligible to make a reservation/waitlist for an event you must make a GET request to the following URL:
/Sales/API/CalendarEvent/CheckEligibility

{EventID} is a required query string parameter. If the {MemberID} query string parameter is not passed, the member will be gotten from the access token. If the {FamilyID} query string parameter is not passed and the {MemberID} parameter is passed, eligibility will be checked for every member in the family. The optional {CheckToAddToWaitList} boolean query string parameter can be passed to check if the member is eligible to be added to the waitlist.

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing if a member is eligible to make a reservation/waitlist.

Result example :
                 [{"EventID":1,
                    "MemberID":1234,
                    "FamilyID":0,
                    "MemberFamilyID": "1234-0",
                    "MemberName": "John Doe",
                    "IsEligible": false,
                    "HasReservation": false, 
                    "HasWaitList": false,
                    "ErrorMessage": "Reservations did not begin yet."},
                  {"EventID":1,
                    "MemberID":1234,
                    "FamilyID":1,
                    "MemberFamilyID": "1234-1",
                     "MemberName": "Jane Doe",
                    "IsEligible": false,
                    "HasReservation": false,  
                    "HasWaitList": false,
                    "ErrorMessage": "Member must be at least 21 years old to attend this event."}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Make event reservation

Required Permission: Sales-Calendar Events(Modify)

# Example CURL to make calendar event reservation
curl \
-X POST {baseUrl}/Sales/API/CalendarEvent/MakeReservation \
-H 'Authorization: Bearer {access_token}' \
-d 'EventID=1234&MemberID=1111&FamilyID=0' 

                

To make a calendar event reservation you must make a POST request to the following URL:
/Sales/API/CalendarEvent/MakeReservation

The request must contain the POST parameters of EventID, MemberID, and FamilyID.

If the request is successful, a HTTP 200 response will be returned with a JSON object containing a boolean property called 'success'.

Response:
{"success":true}
                

POST PARAMETERS

RESPONSE

Cancel event reservation

Required Permission: Sales-Calendar Events(Modify)

# Example CURL to cancel calendar event reservation
curl \
-X POST {baseUrl}/Sales/API/CalendarEvent/CancelReservation \
-H 'Authorization: Bearer {access_token}' \
-d 'EventID=1234&MemberID=1111&FamilyID=0' 

                

To cancel a calendar event reservation you must make a POST request to the following URL:
/Sales/API/CalendarEvent/CancelReservation

The request must contain the POST parameters of EventID, MemberID, and FamilyID.

If the request is successful, a HTTP 200 response will be returned with a JSON object containing a boolean property called 'success'.

Response:
{"success":true}
                

POST PARAMETERS

RESPONSE

Make event waitlist

Required Permission: Sales-Calendar Events(Modify)

# Example CURL to make calendar event waitlist
curl \
-X POST {baseUrl}/Sales/API/CalendarEvent/MakeWaitList \
-H 'Authorization: Bearer {access_token}' \
-d 'EventID=1234&MemberID=1111&FamilyID=0' 

                

To make a calendar event waitlist you must make a POST request to the following URL:
/Sales/API/CalendarEvent/MakeWaitList

The request must contain the POST parameters of EventID, MemberID, and FamilyID.

If the request is successful, a HTTP 200 response will be returned with a JSON object containing a boolean property called 'success'.

Response:
{"success":true}
                

POST PARAMETERS

RESPONSE

Cancel event waitlist

Required Permission: Sales-Calendar Events(Modify)

# Example CURL to cancel calendar event waitlist
curl \
-X POST {baseUrl}/Sales/API/CalendarEvent/CancelWaitList \
-H 'Authorization: Bearer {access_token}' \
-d 'EventID=1234&MemberID=1111&FamilyID=0' 

                

To cancel a calendar event waitlist you must make a POST request to the following URL:
/Sales/API/CalendarEvent/CancelWaitList

The request must contain the POST parameters of EventID, MemberID, and FamilyID.

If the request is successful, a HTTP 200 response will be returned with a JSON object containing a boolean property called 'success'.

Response:
{"success":true}
                

POST PARAMETERS

RESPONSE

Search for calendar categories

Required Permission: Sales-Calendar Events(Allow)

# Example Search calendar categories URL
/Sales/API/CalendarEvent/SearchCategories

                

To search calendar categories you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchCategories

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar categories.

Result example :
                 [{"CategoryID":1,
                    "Name":"Fitness",
                    "Deleted":false}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Search for calendar locations

Required Permission: Sales-Calendar Events(Allow)

# Example Search calendar locations URL
/Sales/API/CalendarEvent/SearchLocations

                

To search calendar locations you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchLocations

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar locations.

Result example :
                 [{"LocationID":1,
                    "BranchID": 123,
                    "Name":"Swimming Pool",
                    "Deleted":false,
                    "BranchName": "YMCA Branch"}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Search for calendar instructors

Required Permission: Sales-Calendar Events(Allow)

# Example Search calendar instructors URL
/Sales/API/CalendarEvent/SearchInstructors

                

To search calendar instructors you must make a GET request to the following URL:
/Sales/API/CalendarEvent/SearchInstructors

If the request is successful, a HTTP 200 response will be returned with a JSON array of objects representing calendar instructors.

Result example :
                 [{"InstructorID":1,
                    "BranchID": 123,
                    "Name":"John Doe",
                    "Deleted":false,
                    "BranchName": "YMCA Branch"}]
                

QUERY PARAMETERS

RESPONSE PROPERTIES

Get calendar descriptors

Required Permission: Sales-Calendar Events(Allow)

    # Example Get calendar descriptors URL
    /Sales/API/CalendarEvent/GetBranchAndLocationDescriptors

To get calendar descriptors you must make a GET request to the following URL:
/Sales/API/CalendarEvent/GetBranchAndLocationDescriptors

If the request is successful, a HTTP 200 response will be returned with a JSON object with the properties of BranchDisplayName and LocationDisplayName.

Result example :
                 {"BranchDisplayName":"Branch",
                    "LocationDisplayName": "Type"}
                

RESPONSE PROPERTIES

Response codes

The API uses the following response codes: