Introduction
APIKey is used to authenticate and identity account info.
SecretKey is used as a security measure. Only use it on the server side and do NOT share it.
Get Customer Address
Description:
This is a GET request.
URL:
/api/fitwarecustomerservice/getcustomeraddress/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareaddressservice/getcustomeraddress/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
"result": {
"addressID": 10692,
"addressTypeID": 2,
"street1": "2411 Galpin Court",
"street2": "",
"street3": "",
"countryID": 1,
"stateID": 24,
"cityID": 4585,
"zipCodeID": 23850,
"optionalField": "",
"xREF_Route": null,
"city": {
"cityID": 4585,
"stateID": 24,
"countryID": 1,
"cityName": "Chanhassen",
"isActive": true,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:04:26.75",
"updateUserID": -1,
"updateDate": "2011-11-16T14:04:26.75"
},
"country": {
"countryID": 1,
"countryName": "United States",
"isActive": true,
"countryCode": "US",
"countryCode2": "USA",
"billingFrequencyTypeID": 1,
"isDeleted": false,
"createUserID": 1,
"createDate": "2010-09-08T12:21:34.5",
"updateUserID": 1,
"updateDate": "2010-09-08T12:21:34.5"
},
"state": {
"stateID": 24,
"countryID": 1,
"stateName": "Minnesota",
"isActive": true,
"stateCode": "MN",
"isDeleted": false,
"createUserID": 1,
"createDate": "2010-09-09T13:39:02.603",
"updateUserID": 1,
"updateDate": "2010-09-09T13:39:02.603"
},
"zipCode": {
"zipCodeID": 23850,
"zipCodeValue": "55317",
"countryID": 1,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:04:25.373",
"updateUserID": -1,
"updateDate": "2011-11-16T14:04:25.373"
},
"countryISO3": "USA",
"stateISO2": "MN",
"postalCode": "55317",
"cityName": "Chanhassen",
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:06:29.81",
"updateUserID": 6111,
"updateDate": "2015-03-16T17:16:06.37"
},
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Club Address
Description:
This is a GET request.
URL:
/api/fitwareenrollmentservice/getclubaddress/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
ClubID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareaddressservice/getclubaddress/[[API KEY HERE]]'
//parameters
ClubID=1
Result:
{
"result": {
"addressID": 10692,
"addressTypeID": 2,
"street1": "2411 Galpin Court",
"street2": "",
"street3": "",
"countryID": 1,
"stateID": 24,
"cityID": 4585,
"zipCodeID": 23850,
"optionalField": "",
"xREF_Route": null,
"city": {
"cityID": 4585,
"stateID": 24,
"countryID": 1,
"cityName": "Chanhassen",
"isActive": true,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:04:26.75",
"updateUserID": -1,
"updateDate": "2011-11-16T14:04:26.75"
},
"country": {
"countryID": 1,
"countryName": "United States",
"isActive": true,
"countryCode": "US",
"countryCode2": "USA",
"billingFrequencyTypeID": 1,
"isDeleted": false,
"createUserID": 1,
"createDate": "2010-09-08T12:21:34.5",
"updateUserID": 1,
"updateDate": "2010-09-08T12:21:34.5"
},
"state": {
"stateID": 24,
"countryID": 1,
"stateName": "Minnesota",
"isActive": true,
"stateCode": "MN",
"isDeleted": false,
"createUserID": 1,
"createDate": "2010-09-09T13:39:02.603",
"updateUserID": 1,
"updateDate": "2010-09-09T13:39:02.603"
},
"zipCode": {
"zipCodeID": 23850,
"zipCodeValue": "55317",
"countryID": 1,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:04:25.373",
"updateUserID": -1,
"updateDate": "2011-11-16T14:04:25.373"
},
"countryISO3": "USA",
"stateISO2": "MN",
"postalCode": "55317",
"cityName": "Chanhassen",
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-11-16T14:06:29.81",
"updateUserID": 6111,
"updateDate": "2015-03-16T17:16:06.37"
},
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Current Due Invoices
Description:
This is a GET request.
URL:
/api/fitwarebillingservice/getcurrentdueinvoices/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarebillingservice/getcurrentdueinvoices/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Get Current Due Amount
Description:
This is a GET request.
URL:
/api/fitwarebillingservice/getcurrentdueamount/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarebillingservice/getcurrentdueamount/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Get Payment Method Customers
Description:
This is a GET request.
URL:
/api/fitwarepaymentmethodservice/getpaymentmethodcustomers/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
PaymentMethodID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarepaymentmethodservice/GetPaymentMethodCustomers/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
"result": [
{
"customerID": 4819021,
"id": 4819021,
"personTypeID": 4,
"salutationID": null,
"firstName": "TestFirst1",
"lastName": "TestLast1",
"mi": null,
"pin": null,
"gender": false,
"image": null,
"sourceID": null,
"leadGeneratorID": null,
"referredByID": null,
"birthDate": "1991-01-01T00:00:00",
"onAccountUnscheduledBalance": 0,
"primaryPaymentMethodID": 4696481,
"groupID": null,
"emergencyName": "",
"emergencyNumber": null,
"statusID": 10,
"parentID": null,
"companyID": null,
"contactTypeID": null,
"campaignID": null,
"doNotContact": false,
"prospectInsertedByMethod": 2,
"employeeNumber": "",
"checkfreeCustomerID": null,
"igoMemberGUID": null,
"firstName_LastName": "TestFirst1 TestLast1",
"preferredNickname": null,
"lastVisitDate": null,
"gymSalesPersonID": null,
"isDeleted": false,
"createUserID": 1,
"createDate": "2015-11-03T21:08:09.097",
"updateUserID": 1,
"updateDate": "2015-11-03T21:08:09.097"
}
],
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Club
Description:
This is a GET request.
URL:
/api/fitwarebilingservice/getclub/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
ClubNumber | Integer | 50 | Yes |
Example:
//url
'/api/fitwarebilingservice/getclub/[[API KEY HERE]]'
//parameters
ClubNumber=957
Result:
Get Customer Current Club
Description:
This is a GET request.
URL:
/api/fitwarebilingservice/getcustomercurrentclub/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarebilingservice/getcustomercurrentclub/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Get Customer
Description:
This is a GET request.
URL:
/api/fitwarebilingservice/getCustomer/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarecustomerservice/getcustomer/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
"result": {
"customerID": 60160,
"id": 60160,
"personTypeID": 5,
"salutationID": 1,
"firstName": "Maria",
"lastName": "Fiecas",
"mi": null,
"pin": null,
"gender": true,
"image": null,
"sourceID": null,
"leadGeneratorID": null,
"referredByID": null,
"birthDate": null,
"onAccountUnscheduledBalance": 0,
"primaryPaymentMethodID": 1452988,
"groupID": null,
"emergencyName": null,
"emergencyNumber": null,
"statusID": 19,
"parentID": null,
"companyID": null,
"contactTypeID": null,
"campaignID": 187,
"doNotContact": false,
"prospectInsertedByMethod": 1,
"employeeNumber": null,
"checkfreeCustomerID": 229980,
"igoMemberGUID": null,
"firstName_LastName": "Maria Fiecas",
"preferredNickname": null,
"lastVisitDate": null,
"gymSalesPersonID": null,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-01-20T09:08:01.217",
"updateUserID": -1,
"updateDate": "2011-01-20T09:08:01.217"
},
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Customer Phone Numbers
Description:
This is a GET request.
URL:
/api/fitwarecustomerservice/getCustomerPhoneNumbers/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarecustomerservice/getcustomerphonenumbers/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
"result": {
"homeContactInfoID": null,
"homeContactInfoTypeID": null,
"homePhoneNumber": null,
"cellContactInfoID": 256879,
"cellContactInfoTypeID": 13,
"cellPhoneNumber": "281 426 2377",
"workContactInfoID": null,
"workContactInfoTypeID": null,
"workPhoneNumber": null
},
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Customer Email Address
Description:
This is a GET request.
URL:
/api/fitwarecustomerservice/getCustomerEmailAddress/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarecustomerservice/getCustomerEmailAddress/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Get Customer Status
Description:
This is a GET request.
URL:
/api/fitwarecustomerservice/getcustomerstatus/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarecustomerservice/getcustomerstatus/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
"result": {
"customerToStatusID": 150002,
"customerID": 60160,
"membershipPlanContractID": null,
"statusID": 19,
"effectiveDate": "2012-06-21T21:22:53.723",
"endDate": null,
"reason": null,
"note": null,
"customerStatusUpdateMethod": 2,
"contractCleanupNotes": "",
"customer": {
"customerID": 60160,
"id": 60160,
"personTypeID": 5,
"salutationID": 1,
"firstName": "Maria",
"lastName": "Fiecas",
"mi": null,
"pin": null,
"gender": true,
"image": null,
"sourceID": null,
"leadGeneratorID": null,
"referredByID": null,
"birthDate": null,
"onAccountUnscheduledBalance": 0,
"primaryPaymentMethodID": 1452988,
"groupID": null,
"emergencyName": null,
"emergencyNumber": null,
"statusID": 19,
"parentID": null,
"companyID": null,
"contactTypeID": null,
"campaignID": 187,
"doNotContact": false,
"prospectInsertedByMethod": 1,
"employeeNumber": null,
"checkfreeCustomerID": 229980,
"igoMemberGUID": null,
"firstName_LastName": "Maria Fiecas",
"preferredNickname": null,
"lastVisitDate": null,
"gymSalesPersonID": null,
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-01-20T09:08:01.217",
"updateUserID": -1,
"updateDate": "2011-01-20T09:08:01.217"
},
"status": {
"statusID": 19,
"statusName": "Inactive",
"personTypeID": 5,
"isActive": true,
"isDeleted": false,
"createUserID": null,
"createDate": "2010-09-07T08:56:21.657",
"updateUserID": null,
"updateDate": "2010-09-07T08:56:21.657",
"statusCode": "ProspectStatusInactive"
},
"isDeleted": false,
"createUserID": -1,
"createDate": "2011-01-20T09:08:01.217",
"updateUserID": 874,
"updateDate": "2014-02-17T13:42:19.73"
},
"meta": {
"serviceStatus": "Success",
"responseCode": {
"code": "A01",
"description": "Accepted"
}
}
}
Get Customer Barcode
Description:
This is a GET request.
URL:
/api/fitwarecustomerservice/getCustomerBarcode/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwarecustomerservice/getCustomerBarcode/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Enroll Membership
Description:
Create a membership with members attached to it. This is a POST request. It will attempt
to create a membership plan contract, payment method, and customer records.
URL:
/api/fitwareenrollmentservice/enrollmembership/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
MembershipPlanName | String | 40 | Yes | |||||||
|
||||||||||
MembershipStartDate | UTC Date | 25 | No | |||||||
Defaults to Current Date. | ||||||||||
MembershipEndDate | UTC Date | 25 | No | |||||||
FirstBillingDate | UTC Date | 25 | Yes | |||||||
MonthlyDues | Int | 10 | Yes | |||||||
Example $39.99 = 3999. | ||||||||||
TermName | String | 50 | Yes | |||||||
|
||||||||||
BillingFrequencyName | String | 50 | Yes | |||||||
|
||||||||||
ClubNumber | String | 50 | Yes | |||||||
Source | String | 100 | No | |||||||
IsAutoRenew | Bool | 5 | No | |||||||
|
||||||||||
AutoRenewMonthlyDues | int | 10 | No | |||||||
PaymentMethod - PaymentMethodTypeName | String | 50 | Yes | |||||||
|
||||||||||
PaymentMethod - CreditCardTypeName | String | 50 | No | |||||||
|
||||||||||
PaymentMethod - Token | String | 50 | Yes | |||||||
PaymentMethod - ExpMonth | Int | 2 | No | |||||||
Format in two digit, Example 02. | ||||||||||
PaymentMethod - ExpYear | Int | 4 | No | |||||||
Format in four digit, Example 2017. | ||||||||||
PaymentMethod - LastFourDigits | String | 4 | Yes | |||||||
PaymentMethod - BankName | String | 100 | No | |||||||
PaymentMethod - RoutingNumber | String | 50 | No | |||||||
Address - Street1 | String | 200 | No | |||||||
Address - Street2 | String | 200 | No | |||||||
Address - City | String | 100 | No | |||||||
Address - State | String | 2 | Yes | |||||||
Format in ISOCode2, Example NY. | ||||||||||
Address - Country | String | 3 | Yes | |||||||
Format in ISOCode3, Example USA. | ||||||||||
Address - PostalCode | String | 50 | No | |||||||
Members - FirstName | String | 100 | Yes | |||||||
Members - LastName | String | 100 | Yes | |||||||
Members - Gender | String | 6 | Yes | |||||||
|
||||||||||
Members - BirthDate | Date | 25 | Yes | |||||||
Members - PhoneNumber | String | 25 | No | |||||||
Format in 999-999-9999. | ||||||||||
Members - EmailAddress | String | 100 | No | |||||||
Members - EmergencyName | String | 100 | No | |||||||
Members - EmergencyNumber | String | 50 | No | |||||||
Members - IsPrimary | Bool | 5 | Yes | |||||||
Members - SplitPercent | Int | 5 | Yes | |||||||
Example 100 == 100%. Used for splitting monthly dues. If you don't know use 100 for the primary member. |
||||||||||
Members - Barcode | Date | 16 | No | |||||||
Members - ReferenceCode | String | 25 | No |
Example:
//url
'/api/fitwareenrollmentservice/enrollmembership/[[API KEY HERE]]'
//parameters
{
"MembershipPlanName":"Single - Reciprocal"
,"MembershipStartDate":"09/01/2015"
,"MembershipEndDate":null
,"FirstBillingDate":"09/01/2015"
,"MonthlyDues":"3999"
,"TermName":"Month to Month"
,"BillingFrequencyName":"Monthly"
,"ClubNumber":"957"
,"PaymentMethod":{
"PaymentMethodTypeName":"Credit Card"
,"CreditCardTypeName":"VISA"
,"Token":"someLameToken2119"
,"ExpMonth":"01"
,"ExpYear":"2017"
,"LastFourDigits":"2119"
}
,"Address":{
"Street1":"123 Main St."
,"City":"Savage"
,"State":"MN"
,"PostalCode":"55378"
,"Country":"USA"
}
,"Members":[{
"FirstName":"TestFirst1"
,"LastName":"TestLast1"
,"Gender":false
,"BirthDate":"1/1/1991"
,"PhoneNumber":"999-999-9999"
,"EmailAddress":"[email protected]"
,"EmergencyName":""
,"EmergencyNumber":""
,"IsPrimary":true
,"SplitPercent":100
,"ReferenceCode":"abc"
}]
}
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
, result:{
customers: [
{
"referenceCode": "abc",
"customerID": 4702718
}
]
}
}
Update Barcode
Description:
This is a POST request.
URL:
/api/fitwareenrollmentservice/updatebarcode/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Barcode | String | 20 | Yes |
Example:
//url
'/api/fitwareenrollmentservice/updatebarcode/[[API KEY HERE]]'
//parameters
CustomerID=123456
Barcode=456789
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Terminate Membership
Description:
Updates all customers to status of terminated. End contract.
URL:
/api/fitwareenrollmentservice/enrollmembership/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
MembershipPlanContractID | Integer | 20 | Yes |
CustomerStatusNote | String | 100 | No |
Example:
//url
'/api/fitwareenrollmentservice/terminatemembership/[[API KEY HERE]]'
//parameters
membershipplancontractID = 123
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Reissue Fit Pass Trial Membership
Description:
Terminates the current customer Fit Pass trial and reissues a new trial membership.
URL:
/api/fitwareenrollmentservice/reissuethirtydaytrialmembership/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
MembershipPlanContractID | Integer | 20 | Yes |
MembershipStartDate | Date | 25 | No |
Defaults to current date | |||
MembershipEndDate | Date | 25 | No |
Defaults to membership start date + 30 days |
Example:
//url
'/api/fitwareenrollmentservice/reissuethirtydaytrialmembership/
[[API KEY HERE]]'
//parameters
membershipplancontractID = 123
membershipendstartdate=01/31/2015
membershipendenddate=02/28/2015
Result:
{
"result": {
"membershipPlanContractID": 123456
},
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Get Contracts
Description:
This is a GET request.
URL:
/api/fitwareenrollmentservice/getcontracts/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareenrollmentservice/getcontracts/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Get Customer Current Membership Contract
Description:
This is a GET request.
URL:
/api/fitwareenrollmentservice/getcustomercurrentmembershipcontract/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareenrollmentservice/getcustomercurrentmembershipcontract/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
Register Club
Description:
Register club. This is a POST request. It will attempt to create or update the
company in GymSales.
URL:
/api/fitwareprospectservice/registerclub/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
ClubNumber | String | 50 | Yes |
Example:
//url
'/api/fitwareprospectservice/registerClub/[[API KEY HERE]]'
//parameters
ClubNumber=957
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
, result:{
token: "some token"
}
}
Register User
Description:
Register User. This is a POST request. It will attempt to create or update
the user in GymSales. It will also set the user's access in GymSales. It
only accepts ClubNumbers that are registered in GymSales.
URL:
/api/fitwareprospectservice/registerUser/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
UserID | String | 50 | Yes |
ClubNumbers | Array String | 100 | Yes |
Example: ["10000","957"] |
Example:
//url
'/api/fitwareprospectservice/registeruser/[[API KEY HERE]]'
//parameters
{
UserID:123
ClubNumbers:["10000","957"]
}
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Get Auth Token
Description:
Gets an authorization token. This is a POST request. It is used to
authenticate into GymSales. UserID is required. If ClubNumber is passed in
it will push the user into that company into GymSales. If CustomerID is
passed in it will open the person record in GymSales.
URL:
/api/fitwareprospectservice/getAuthToken/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
UserID | Integer | 50 | Yes |
CustomerID | Integer | 50 | No |
ClubNumber | Integer | 50 | No |
Example:
//url
'/api/fitwareprospectservice/getauthtoken/[[API KEY HERE]]'
//parameters
UserID=123
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
, result:{
token: "some token"
}
}
Create Prospect
Description:
Create a prospect. This is a POST request. It will create a Fitware prospect.
It will also sync the prospect into GymSales. If CustomerID and the required
columns are passed in it will NOT create a Fitware Prospect and it will only
push to GymSales.
URL:
/api/fitwareprospectservice/createProspect/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |||
---|---|---|---|---|---|
FirstName | String | 100 | Yes | ||
LastName | String | 100 | Yes | ||
BirthDate | Date | 25 | Yes | ||
Gender | Bool | 5 | Yes | ||
|
|||||
EmailAddress | String | 100 | No | ||
PhoneHome | String | 25 | No | ||
PhoneWork | String | 25 | No | ||
PhoneCell | String | 25 | No | ||
Street1 | String | 200 | No | ||
Street2 | String | 200 | No | ||
City | String | 100 | No | ||
State | String | 2 | No | ||
Format in ISOCode2, Example NY. | |||||
Country | String | 3 | No | ||
Format in ISOCode3, Example USA. | |||||
PostalCode | String | 50 | No | ||
Barcode | String | 16 | No | ||
ClubNumber | String | 50 | Yes | ||
Source | String | 100 | No | ||
CustomerID | String | 25 | No |
Example:
//url
'/api/fitwareprospectservice/createprospect/[[API KEY HERE]]'
//parameters
FirstName=Alex
LastName=Conway
BirthDate=12/01/1986
Gender=false
[email protected]
PhoneHome=999-999-9999
PhoneCell=
PhoneWork=
Street1=2411 Galpin Ct
Street2=
City=Chanhassen
State=MN
Country=USA
PostalCode=55318
ClubNumber=957
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
result:{
CustomerID:123
}
}
Post Sale To Gym Sales
Description:
Post Sale To Gym Sales. This is a POST request.
URL:
/api/fitwareprospectservice/postGymSalesSale/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareprospectservice/postGymSalesSale/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Post Trial To Gym Sales
Description:
Post Trial To Gym Sales. This is a POST request.
URL:
/api/fitwareprospectservice/postGymSalesTrial/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
CustomerID | Integer | 50 | Yes |
Example:
//url
'/api/fitwareprospectservice/postGymSalesTrial/[[API KEY HERE]]'
//parameters
CustomerID=1
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
}
Register Gymsales Prospect
Description:
This is a POST request.
URL:
/api/fitwareenrollmentservice/registergymsalesprospect/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
id | Integer | 50 | Yes |
external_id | Integer | 50 | No |
company_id | String | 50 | No |
company_external_id | String | 50 | Yes |
first_name | String | 100 | Yes |
last_name | String | 100 | Yes |
address | String | 300 | No |
city | String | 300 | No |
state | String | 3 | No |
zip | String | 50 | No |
phone_home | String | 250 | No |
phone_mobile | String | 250 | No |
phone_work | String | 250 | No |
String | 250 | No | |
contact_method_name | String | 50 | No |
source_name | String | 100 | No |
tag_list | String | 100 | No |
avatar | String | 500 | No |
social_link | String | 100 | No |
salesperson | String | 200 | No |
status | String | 50 | No |
trial_end_at | String | 50 | No |
trial_days_quantity | String | 10 | No |
Example:
//url
'/api/fitwareenrollmentservice/registergymsalesprospect/[[API KEY HERE]]'
//parameters
id=646287
company_external_id=957
first_name=jill
last_name=jones
Result:
{
result: {
customerID: '4703232'
},
meta: {
serviceStatus: 'Success',
responseCode: {
code: 'A01',
descriptio: 'Accepted'
}
}
}
Quick Customer Search
Description:
Gets an list of customers for a club. This is a POST request. Club Number is required.
URL:
/api/fitwareprospectservice/quickcustomersearch/[[API KEY HERE]]
Parameters:
Type | Max Len | Req. | |
---|---|---|---|
ClubNumber | sting | 20 | Yes |
Phone | string | 50 | No |
EmailAddress | string | 100 | No |
Example:
//url
'/api/fitwareprospectservice/quickcustomersearch/[[API KEY HERE]]'
//parameters
ClubNumber=999
Phone=999-999-9999
[email protected]
Result:
{
meta: {
responseCode:{
code: 'A01'
,description: 'Accepted'
}
, serviceStatus: 'Success'
}
, result:"customers": [
{
"customerID": 12345,
"firstName": "John",
"lastName": "Doe",
"address1": "123 main street",
"city": "eden prairie",
"state": "mn",
"postalCode": "55347",
"country": "usa"
},
{
"customerID": 12346,
"firstName": "Jane",
"lastName": "doe",
"address1": "123 main street",
"city": "eden prairie",
"state": "mn",
"postalCode": "55347",
"country": "usa"
}
],
}