Get started
API Endpoint http://demo.joynadmin.org/
The joyn API enables our client to link their association website with the AMS software or access and manage their association data in joyn using a 3rd party integration.
All APIs under the joyn API are based on REST architecture and are accessed via HTTPS at specified URLs. To use joyn API you will need to be a client or a vendor associated with on of our clients. Please contact API Admin to get the secret key and relevant information to consume our APIs.
doLoginPOST
Response:
{
"aff_id": "Affiliate ID",
"user_fname": "First name",
"user_lname": "Last name",
"member_cat": "Member category",
"member_type": "Member Type / User Type",
"paid_thru_date.sec": "Paid through date of an affiliate. i.e, Affliate membership is valid till this date. Field value is in Unix timestamp (the number of seconds since January 1 1970 00:00:00 UTC)",
"pay_dues": "true / false This affiliate has any open billing documents to pay?",
"org": "True / False This will let you know if affiliate is organization record or not",
"mstatus": "Member Status Like Active/Inactive/Lapsed etc."
}
Another type of response for assistant login with multiple connection
{
"asst_login_users": [{
"id": 5010212,
"fname": "John",
"lname": "Doe",
"email": "[email protected]",
"prof_pic": ""
}, {
"id": 5010441,
"fname": "Smith",
"lname": "Jones",
"email": "[email protected]",
"prof_pic": ""
}]
}
To validate affiliate record by giving e-mail and password of the affiliate.
http://demo.joynadmin.org/login/server/core.php/doLogin
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
string | E-mail address of an affiliate. This is affiliate’s login id. | |
pass | string | Password |
resetPasswordPOST
Response:
{
success: 1
}
To reset affiliate’s existing password and send new password to affiliate’s login e-mail address.
http://demo.joynadmin.org/login/server/core.php/resetPassword
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
string | E-mail address of an affiliate. This is affiliate’s login id. |
changePasswordGET
Response:
{
success: 1
}
To change affiliate’s password.
http://demo.joynadmin.org/login/server/core.php/changePassword
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
string | E-mail address of an affiliate. This is affiliate’s login id. | |
old_pass | string | Old Password |
new_pass | string | New password to replace old password. |
createActivityTypePOST
Response:
{
act_id: 23 (integer)
}
API to create a new Activity type that can be managed in the Joyn
http://demo.joynadmin.org/user/server/api.php/createActivityType
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
name | string | Name of the activity type |
field_setup | array | Ex: [ { "f_id": "aff_def", "lbl": "Affiliate", "f_sett": "REQ", "f_type": "AFF" }, { "f_id": "cf1", "lbl": "Field 1", "f_sett": "OPT", "f_type": "CONF" }, { "f_id": "cf2", "lbl": "Field 2", "f_sett": "OPT", "f_type": "DF" }, { "f_id": "cf3", "lbl": "Field 3", "f_sett": "OPT", "f_type": "DD", "ddsettings": [ { "k": "cf3_dd_1", "v": "DD1", "hide": false }, { "k": "cf3_dd_2", "v": "DD2", "hide": false }, { "k": "cf3_dd_3", "v": "DD3", "hide": false } ] }, { "f_id": "cf4", "lbl": "Field 4", "f_sett": "REQ", "f_type": "EF", "maxC": 100 } ] |
addActivityPOST
Response:
{
"success": 1
}
Use this API to create an activity for an activity type
http://demo.joynadmin.org/user/server/api.php/addActivity
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
activity | JSON | Ex: {"act_id": 40004, "aff_def": 5000007, "cf1": 10001, "cf2": 1589972726, "cf3": "cf3_dd_3", "cf4": "Test Text"} |
date_field | array | Ex: ["cf2"] |
getActivityGET
Response:
{
"activity": OBJECT
"success": 1
}
Use this API to get activity record that matches your query
http://demo.joynadmin.org/user/server/api.php/getActivity
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
query_fld | JSON | Ex: {"act_id": 40004, "aff_def": 5000007, "cf1": 10002} |
date_field | array | [] |
updateActivityPOST
Response:
{
"success": 1
}
Use this API to update an activity record that matches your query
http://demo.joynadmin.org/user/server/api.php/updateActivity
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
query | JSON | Ex: {"act_id": 40004, "aff_def": 5000007, "cf1": 10002} |
activity | JSON | Ex: {"cf2": 1631796164, "cf3": "cf3_dd_2", "cf4": "Test Text Update"} |
date_field | array | ["cf2"] |
getActivitiesGET
Response:
{
"activity": ARRAY of OBJECTS
"success": 1
}
Use this API to get all the matching activity records for your query
http://demo.joynadmin.org/user/server/api.php/getActivities
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
query_fld | JSON | Ex: {"act_id": 40004, "aff_def": 5000007} |
date_field | array | [] |
getActivityTypesGET
Response:
{
"activity_types": ARRAY of OBJECTS
}
Use this API to get all the active activity types available in the system
http://demo.joynadmin.org/user/server/api.php/getActivityTypes
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
deleteActivityPOST
Response:
{
"success": 1
}
Use this API to delete all the activities that match your query
http://demo.joynadmin.org/user/server/api.php/deleteActivity
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
query | JSON | Ex: {"act_id": 40004, "aff_def": 5000007, "cf1": 10002} |
getDropdownsGET
Response:
Each dropdown field will have an array of keys (Field name “k”) and values (Field name “v”). Always key should be passed to create / update user account.
For example, if user selects “Male” as his gender, then key value of Male is “M” and this should be passed to “gender” field to create / update user details.
{
"prefix": [
{
"k": "Mr",
"v": "Mr."
},
{
"k": "Dr",
"v": "Dr."
},
{
"k": "Mrs",
"v": "Mrs."
},
}
To get dropdown values like Country, State, Gender etc. Refer Dropdown Field column in user_account_field_list.xls file for user account dropdown fields.
http://demo.joynadmin.org/common/server/core.php/getDropdowns
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
fields | array | Array of field values Example: ["prefix", "suffix", "design", "country", "chapter"] in javascript |
creditEduHoursPOST
Response:
{
success: 1
}
Uses to API to Credit an Affiliate with Education Hours for the course time they completed
http://demo.joynadmin.org/user/server/api.php/creditEduHours
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Assoc ID |
aff_id | id | Affiliate ID |
course_name | string | Ex: How RESTful API work? |
learning_origin | string | Ex: BlueSky PathLMS |
total_mins | number | Ex: 129 |
getConfRegistrationListGET
Response:
{
registrations: Matching Registrations, Records (Array of Object),
reg_count: Count of Matched Records (integer)
}
registrations:
{
reg_id: Registration ID (integer),
primary_reg_type: Primary registration type(string),
primary_reg_type_desc: Primary registration type description(string),
total_amt: Total amount paid(floating point),
created_on: Created on Date(Date time string),
paid_date: Paid on Date(Date time string),
reg_status: Registration Status (string)
aff_id: Affiliation ID (integer)
prefix: prefix (string),
fname: First name (string),
mname: Middle name (string),
lname: Last name (string),
suffix: Suffix (string)
pref_name: Preferred Name (string),
disp_name: Disp Name (string)
email: Email (string),
desig: Designation (string),
company: Company/Affiliation (string),
jtitle: Job Title (string),
mcat: Affiliate Category (string),
mstatus: Affiliate Status (string),
user_tupe: Affiliate type (string),
pthru: Paid through date (Datetime string),
jn_date: Join Date (Datetime string),
add1: Address 1 (string),
add2: Address 2 (string),
add3: Address 3 (string),
city: City (string),
state: State (string),
zip: Zip Code (string),
country: Country (string),
phone: Phone (string),
reg_details: Registration Details (array of objects)
}
Use this API to get the list affiliate who are registered for a conference and filter based on status, created on date and paid date
http://demo.joynadmin.org/user/server/api.php/getConfRegistrationList
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
conf_id | number | Conference ID |
status | array | Registration Status |
paid_bdate | timestamp | Paid Date Range Begin Date |
padi_edate | timestamp | Paid Date Range End Date |
created_bdate | timestamp | Created On Date Range Begin Date |
created_edate | timestamp | Created On Date Range Begin Date |
verifyAndCheckInConfAttendeePOST
Response:
{
reg_id: Registration ID (integer),
reg_status: Registration status (string),
reg_status_desc: Registration status description (string)
checkin_timestamp: Checkin timestamp (string),
success: Checkin status (boolean)
}
Use this API to add the check-in timestamp for conference attendee
http://demo.joynadmin.org//user/server/api.php/verifyAndCheckInConfAttendee
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | string | Association ID |
conf_id | number | Conference ID |
aff_id | number | Affiliate ID |
verify_reg_only | boolean | To get only Registration Status with our checking in |
getConfRegistrationInfoGET
Response:
{
"reg_info": [
{
"ques": "Badge Name and Affiliation",
"value": [
[
"WILL",
"SMITH",
"ABC INFO TECH"
]
]
},
{
"ques": "Pronouns",
"value": "He/Him/His"
},
{
"ques": "Cell Phone Number",
"value": "9999900000"
},
{
"ques": "Emergency Contact",
"value": [
[
"JADE",
"0000099999",
"[email protected]"
]
]
},
{
"ques": "Are you a first time attendee?",
"value": "No"
},
{
"ques": "Please indicate the most appropriate descriptors of your academic work:",
"value": "Clinical Care"
},
{
"ques": "Special Dietary Needs",
"value": "None"
},
]
}
Get the details of registration provided by the affiliate during the registration.
Please pass the input as JSON.
http://demo.joynadmin.org/user/server/api.php/getConfRegistrationInfo
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
reg_id | number | Registration Id |
assoc_id | number | Association Id |
getMemberDuesGET
Response:
{
"_id": "Billing document number",
"a_id": "Affiliate ID",
"gross_amt": "Gross amount",
"adj_amt": "Total discount amount",
"adj_det": [{
"amt": "Discount amount",
"r": "Discount reason"
}],
"bill_amt": "Billed amount(Gross Amount– Discount Amount)",
"bill_date.s": "Billed date",
"bdate.sec": "Begin date",
"edate.sec": "End Date",
"o_id": "Order id",
"p_code": "Product code “pcode” is dropdown field.Product descriptions for product codes can be fetched from getDropdowns api.",
"pline": "Product line | Dropdown field– p_line",
"p_grp": "Product Group | Dropdown field– p_grp",
"p_sgrp": "Product Sub Group | Dropdown field– p_sgrp",
"qty": "Quantity",
"recur": "Is this recurring billing ?",
"status": "Billing document status",
"uom": "Currency",
"taxes": "Array | If association has setup any tax for the membership or products applicable tax name and percentage will be sent as array of objects",
"promo_code": "If product has any applicable promo code that can be used then this parameter will be sent as true else this parameter will not be sent",
"secondary_aff_bills": "Array | of object(Bill Details) When primary affiliate logs in to pay member due then we give an option for them to pay all there secondary affiliates associated with affiliate"
}
Use this api to get affiliate’s open billing documents.
http://demo.joynadmin.org/user/server/api.php/getMemberDues
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
searchDirectoryGET
Response:
{
"affiliates": [{
"aff_id": "Affiliate ID",
"fname": "First Name",
"lname": "Last Name",
"email": "E-mail address",
"mcat": "Member Category",
"company": "Company",
"jtitle": "Job Title",
"city": "City",
"state": "State",
"phone": "Phone number",
"search_dir": "Member Search Directory Flag",
}],
"total_Count": "Total number of affiliate matches for given search criteria. This will be helpful in pagination."
}
To search and get affiliate details.
http://demo.joynadmin.org/user/server/api.php/searchDirectory
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
search_from | date | Search start from |
search_to | date | Search till Note: “search_from” and “search_to” fields will be used for pagination. Example: If search_from = 0 and search_to = 10, api will return first 10 records. If search_from = 20 and search_to = 20, api will return second 10 records. |
fname (optional) | string | Search by user first name |
lname (optional) | string | Search by user last name |
email (optional) | string | Search by email |
country (optional) | string | Search by country. Note: Country code should be passed. |
city (optional) | string | Search by city |
state (optional) | string | Search by state |
mcat (optional) | string | Search by Member Category |
member_status (optional) | string | Search by Member status |
company (optional) | string | Search by company name |
user_type (optional) | string | Search by Member/Affiliate Type |
chapter (optional) | string | Search by Chapter (Send as Array of Chapter Keys) or (Send as Keys delimited by comma ‘,’) |
getPrimaryAffConnectionsGET
Response:
{
"affiliates": [
{
"_id": "Affiliate ID",
"fname": "First Name",
"lname": "Last Name",
"email": "Email Address",
"mcat": "Affiliate Category",
"company": "Company Name",
"mstatus": "Affiliate Status",
"pthru": "Paid Through Date",
"user_type": "Affiliate Type",
"company_admin": "Company Admin Flag",
}
],
"count": "Total Number of Connected Affiliates"
}
Use this api to get primary affiliates connection details.
http://demo.joynadmin.org/common/server/user_account.php/getPrimaryAffConnections
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
getUserDetailsGET
Response:
{
"aff_details": {
"_id": 5000002,
"biography": "Dr. O’Connor is a graduate of the U-M Medical School and completed his internal medicine residency at the U-M Medical Center,\nwhere he served as Chief Medical Resident. He currently serves as Associate Division Chief for Clinical Programs in the Division of\nGeneral Medicine.*He is also Medical Director of Briarwood Medical Group. Dr. O’Connor has been cited in The Best Doctors in the\nU.S.: Midwest Edition since 1996. He is interested in comprehensive primary care of adults.",
"company": "University of Michigan Health System",
"disp_name": "Thomas Patrick O’Connor MD",
"dob": {
"sec": 45253,
"usec": 0
},
"email": "[email protected]",
"ethnicity": "W",
"fname": "Thomas",
"gender": "M",
"invited_by": "Carl J. Jenkins",
"jtitle": "Associate Professor, Internal Medicine",
"l_login": {
"sec": 1387941249,
"usec": 418000
},
"lname": "O’Connor",
"mname": "Patrick",
"prefix": "Dr",
"second_cont": {
"fname": "Tammy",
"lname": "Williams",
"phone": "6155551278",
"email": "[email protected]",
"prefix": "Mrs"
},
"user_type": "N"
},
"addresses": [
{
"_id": 7000001,
"a_id": 5000002,
"add1": "123 Cherry Lane",
"add2": "",
"add3": "",
"add_type": "H",
"bill2": 1,
"city": "Ann Arbor",
"company": "",
"country": "US",
"county": "",
"email": "[email protected]",
"email2": 1,
"fax": "",
"mail2": 1,
"mobile": "",
"phone": "",
"ship2": 0,
"state": "MI",
"url": "",
"zip": "48108"
},
]
}
Use this api to get user profile details.
http://demo.joynadmin.org/common/server/user_account.php/getUserDetails
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
updateUserDetailsPOST
Response:
{
success: 1,
aff_id: Affiliate ID
}
To create a new affiliate record or to update an existing affiliate record.
http://demo.joynadmin.org/common/server/user_account.php/updateUserDetails
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
_id | number | 5000002 |
company | string | University of Michigan Health System |
disp_name | string | Thomas Patrick O’Connor Prof. |
dob | date | 45253 |
string | [email protected] | |
ethnicity | string | W |
fname | string | Thomas |
gender | string | M |
invited_by | string | Carl J. Jenkins |
jtitle | string | Associate Professor, Internal Medicine |
lname | string | O’Connor |
mname | string | Patrick |
prefix | string | Dr |
second_cont | json | { "fname": "Tammy", "lname": "Williams", "phone": "6155551278", "email": "[email protected]", "prefix": "Mrs" } |
user_type | string | N |
addresses | array | [ { "_id": 7000001, "a_id": 5000002, "add1": "123 Cherry Lane", "add2": "", "add3": "", "add_type": "H", "bill2": 1, "city": "Ann Arbor", "company": "", "country": "US", "county": "", "email": "[email protected]", "email2": 1, "fax": "", "mail2": 1, "mobile": "", "phone": "", "ship2": 0, "state": "MI", "url": "", "zip": "48108" }, { "_id": 7000002, "a_id": 5000002, "add1": "Briarwood Medical Group - Bldg 3", "add2": "375 Briarwood Circle", "add3": "", "add_type": "W", "bill2": 0, "city": "Ann Arbor", "company": "", "country": "US", "county": "", "email": "[email protected]", "email2": 1, "fax": "7349987100", "mail2": 0, "mobile": "", "phone": "7349987207", "ship2": 1, "state": "MI", "url": "http://www.uofmhealth.org/profile/495/thomaspatrick- oconnor-md", "zip": "48108" } ] |
getPaymentDetailsGET
Response:
{
"payment_details": [{
"_id": "Payment ID",
"a_id": "Affiliate ID",
"b_id": "Billing ID",
"bdate": "Begin Date (Object)",
"edate": "End Date (Object)",
"p_code": "Product Code",
"p_amt": "Paid Amount",
"paid_date": "Paid On Date",
"status": "Payment Status",
"qty": "Quantity",
"notes": "Notes",
}],
"edu_hrs": 1,
}
Use this api to get payment record details of an affiliate.
http://demo.joynadmin.org/user/server/api.php/getPaymentDetails
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
p_code | string | Product Code |
edu_hrs | number | Education hour Flag |
getOpenOrdersGET
Response:
{
"Field": "Description",
"_id": "OrderID",
"a_id": "Affiliate ID",
"b_amt": "Billing Amount",
"bdate": "Begin Date",
"cby": "Created By",
"con": "Created On",
"edate": "End Date",
"freq": "Frequency ",
"uom": "Unit of Money",
"qty": "Quantity",
"status": "Status of the order",
"pterms": "Payment Terms",
"p_line": "Product Line",
"p_grp": "Product Group",
"p_sgrp": "Product Sub Group",
"p_code": "Product Code",
"o_amt": "Order Amt",
"recur": "Recurring Flag"
}
Use this api to get affiliates open order details.
http://demo.joynadmin.org/user/server/api.php/getOpenOrders
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
payMemberDuesPOST
Response:
{
"paid_thru_date.sec": "Updated affiliate paid through date after payment Unix timestamp",
"payment_ids": "Array of payment ids for the paid billing documents",
"success": 1,
}
Once user made payment call this api to clear paid billing documents with payment gateway response.
http://demo.joynadmin.org/user/server/api.php/payMemberDues
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
bill_nums | number | Comma separated billing document numbers Example: 2006052, 2006053 |
aff_id | number | Payment gateway response after successful payment. Note: Gateway response must be set inside another pay_details attribute. Refer payMemberDues.json file. |
auto_renewal (optional) | number | 1 or 0 1 is for true and 0 is for false. |
email_notification (optional) | boolean | true / false If true, system will send payment receipt to corresponding affiliate email address. Default value is “true”. |
installment (optional) | boolean | True or False |
second_aff (optional) | string or array | List of associated secondary affiliate's affiliate id for which the paid through date needs to updated |
ref_b_id(optional) | number | Primary affiliates billing document number |
checkOutMultipleProductPOST
Response:
{
"bill_ids": "Array Billing Numbers",
"bill_amt_details": [
{
"bill_num": "Billing Number",
"bill_amt": "Billing Amount"
}
]
}
To create order and billing for multiple products
http://demo.joynadmin.org/user/server/api.php/checkOutMultipleProduct
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
p_code | array | Product Codes as Array or Comma Delimited |
buyproductPOST
Response:
{
"billNum": Billing ID,
"billAmt": "Billing Amount"
"zero_val_bill": "True will be sent if billing amount is zero (Boolean)"
}
To create order and billing for an affiliate for a product. Note: Request must be sent as JSON request payload. Not as form data post.
http://demo.joynadmin.org/user/server/api.php/buyproduct
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
aff_id | number | Affiliate ID |
p_code | string | Product Code |
fulfillment | string | Creates Activity and Task for Order Shipment (Specific to CMSA) |
applyPromoCodePOST
Response:
{
"success": Boolean,
"msg": "Promotional Discount Applied Successfully
or
Required Parameters were not passed for the API.
or
Promo Code entered is not valid.
or
Selected Bill is not valid.
or
Promo Code already applied for selected bill."
}
To Apply promo code to Billing record This API will directly apply the promo code to Billing records so once the promo code gets applied successfully, shopping cart has to be refreshed to show the new billing amount with promo applied.
http://demo.joynadmin.org/user/server/api.php/applyPromoCode
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
promo_code | string | Promo Code |
p_code | string | Product Code (For Membership Member Category) |
bill_id | string | Billing No |
cancelOpenOrdersPOST
Response:
{
success: true,
orders_closed: Number of Orders closed (Count)
}
To cancel open orders of multiple products
http://demo.joynadmin.org/user/server/api.php/cancelOpenOrders
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID |
p_code | array | Product Codes as Array or Comma Delimited |
updateOrderARBPOST
Response:
{
"success": 1,
}
Once he recurring subscription has been created on the Authorzie.Net we have to update the details of subscription to the order.
http://demo.joynadmin.org/user/server/api.php/updateOrderARB
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
order_id | number | Order ID |
subscription_id | number | Subscription ID from Authorize.Net |
no_email_notification | boolean | True or False (Optional) |
bill_id | number | Billing Id |
linkAuthNetCustProfWithAffProfPOST
Response:
{
success: 1
}
Use this API to Link an Affiliate Profile in the JOYN with Authorize.Net Customer profile details.
http://demo.joynadmin.org/user/server/api.php/linkAuthNetCustProfWithAffProf
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | aff_id Affiliate ID (Integer) |
cust_id | string | Authorize.Net Customer Profile Id (Numeric String) |
pay_prof_id | string | Authorize.Net Payment Profile Id (Numeric String) |
createAuthNetSubByCustProfPOST
Response:
{
"success": 1,
"subscription_ids": [
{
"bill_id": "",
"subscription_id": ""
}
]
}
Use this API to Create an Annual Subscription with Authorize.Net Customer profile details.
http://demo.joynadmin.org/user/server/api.php/createAuthNetSubByCustProf
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID (Integer) |
link_cust_id | boolean | True or False (Optional) |
cust_id | number | Customer ID (Required If link_cust_id is true) |
pay_prof_id | number | Payment Profile ID (Required If link_cust_id is true) |
bills | array | Array of Bill Id and Interval Ex: [{bill_id: “”, interval: “”}] Billing ID (Integer) Interval (Integer) default will be 12 if not sent Interval Can be only Between 1 to 12 |
createAuthNetInstallmentByCustProfPOST
Response:
{
"success": 1,
"installment_id": "Installment ID"
}
Use this API to Create an Installment with Authorize.Net Customer profile details.
http://demo.joynadmin.org/user/server/api.php/createAuthNetInstallmentByCustProf
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID (Integer) |
bill_id | number | Billing ID (Integer) |
interval_length | number | Interval Length (Integer) |
interval_unit | string | Interval Unit (can be “months” or “quarterly”) |
link_cust_id | boolean | True or False (Optional) |
cust_id | number | Customer ID (Required If link_cust_id is true) |
pay_prof_id | number | Payment Profile ID (Required If link_cust_id is true) |
no_email_notification | boolean | True or False (Optional) |
updateAuthNetCustProfWithAffProfPOST
Response:
{
"success": 1
}
Use this API to Update an Affiliate Profile in the JOYN with Authorize.Net Customer profile details.
http://demo.joynadmin.org/user/server/api.php/updateAuthNetCustProfWithAffProf
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID (Integer) |
cust_id | string | Authorize.Net Customer Profile Id (Numeric String) |
pay_prof_id | string | Authorize.Net Payment Profile Id (Numeric String) |
deleteAuthNetCustProfPOST
Response:
{
"success": 1
}
Use this API to delete anAuthorize.Net Customer profile.
http://demo.joynadmin.org/user/server/api.php/deleteAuthNetCustProf
REQUEST PARAMETERS
Field | Type | Description |
---|---|---|
assoc_id | number | Assoc ID |
aff_id | number | Affiliate ID (Integer) |
Response codes and error messages
The JoynAMS API uses the following error codes
Response Code | API | Message | Reason |
---|---|---|---|
401 | ALL | Login Required. | Invalid login credentials |
400 | All | System encounters a problem. Please refresh and try again. | For system failure |
400 | doLogin | Login failed. Verify e-mail address and password. | If login failed |
400 | resetPassword & changePassword | E-mail address or Current password is invalid. | If email or password is invalid. |
400 | changePassword | Password must be at least 6 characters long. | If new password character length is less than 6. |
400 | updateUserDetails | Logon e-mail is mandatory. | If email is missing |
400 | updateUserDetails | Password must be at least 6 characters long. | If password character length is less than 6. |
400 | updateUserDetails | Invalid affiliate ID. | If _id is invalid while update user details |
400 | updateUserDetails | Member category is mandatory to be a prospective member. | If user_type is “M” and not mcat value passed. |
400 | updateUserDetails | Logon e-mail is already in use | When creating a new user account and If e-mail id already exists in the system. |
400 | searchDirectory | Pass search range. | If search_from and search_to fields are not passed. |
400 | searchDirectory | Pass any one of the search field. | If no search criteria is passed. |
400 | getMemberDues | Pass affiliate's id. | If affiliate id is not passed. |
400 | buyproduct | Pass affiliate's id. | If affiliate id is not passed. |
400 | buyproduct | Pass Product Code | If product code is not passed. |
400 | updateOrderARB | Pass order id. | If order Id is not passed |
400 | updateOrderARB | Pass Authorize Subscription Id. | If subscription Id is not passed |
400 | applyPromoCode | Required Parameters were not passed for the API. | If Promo Code or Product Code or Billing Id is not sent |
400 | applyPromoCode | Promo Code entered is not valid. | If Promo Code is not present in the system |
400 | applyPromoCode | Selected Bill is not valid. | If Billing Id is not present in the system |
400 | applyPromoCode | Promo Code already applied for selected bill. | If promo code is already applied to billing record |
400 | getPrimaryAffConnections | Please pass a valid primary affiliate Id to the connections. | If affiliate id passed is invalid |