ClearVantage has an extensive REST-based API. A third-party app may utilize the api to populate the event and attendee information. Note that calls below are for explanatory purposes and the contents of the returned packets can easily be modified (e.g., to pull back more detailed profile information about an attendee). Furthermore, the calls can be fine-tuned to, for example, get only new or updated attendees since the last call was made.

The process starts with making a call to Euclid's authorization service. If valid credentials are provided, a JSON Packet with an access_token is provided. This token along with the client_id must be put into the authorization section of the http request header for all subsequent calls. Please review the links below and their responses to get a better understanding of what the API calls return. Also note that the API allows writing back of attendance and other information, but we have not provided those URLs in the list below.

Authorization

GET: /authorize/[CLIENT ID]/[CLIENT SECRET]
/cvapi/authorize/[CLIENT ID]/[CLIENTSECRET]

Once you get the authorization, you can make the calls below. In the actual production environment, you would place the client_id and the access_token into the authentication portion of the http packet. For the purposes of this demo, we have enabled cookie based authentication so the links below can be made directly. Note that this is just an example of the hundreds of API calls that are available.

Example JSON Return: 
{
  "status":"success",
  "access_token":"{b1c7bf91-7613-4b54-b451-1c970fab2ff7}",
  "token_type":"application",
  "expires_in": "0"
}
Example use of curl to include authorization header: 
curl --location 'https://domain.com' \
--header 'Authorization: oauth_token=3D04A2C6-3F2B-4319-8802-AACCA17FE217' \
Example use of Javascript to include authorization header: 
var url = "https://www.domain.com";

var xhr = new xmlhttprequest();
xhr.open("get", url);

xhr.setrequestheader("cache-control", "no-cache");
xhr.setrequestheader("content-type", "application/json");
xhr.setrequestheader("authorization", "oauth_token={b1c7bf91-7613-4b54-b451-1c970fab2ff7}");

xhr.onreadystatechange = function () {
	if (xhr.readystate === 4) {
		console.log(xhr.status);
		console.log(xhr.responsetext);
	}};

xhr.send();

Documentation

This section provides the client specific documentation for the API. The links provided below show the details for what database is used for the API and client specific field customizations used for the client.

API Documentation

GET: /docs
/cvapi/docs
Returns the page you are viewing now.

Database Information

GET: /test
/cvapi/test
Returns an HTML page that lists what database the API is using. Typically the databases ending in TRAIN are the test databases.

Fieldmapping Information

GET: /fieldmapping
/cvapi/fieldmapping
This call returns the customized field mapping for each client. When making updates to a record, the database field name should be used for updates.

Reference Tables

This section provides extended information from reference tables that are used in field values.

Education Reference

GET: /reference/education
/cvapi/reference/education
This call returns the education reference table values.

Designation Reference

GET: /reference/education
/cvapi/reference/designation
This call returns the designation reference table values.

Industry Reference

GET: /reference/industry
/cvapi/reference/industry
This call returns the education reference table values.

Interest Reference

GET: /reference/interest
/cvapi/reference/interest
This call returns the education reference table values.

Education Reference

GET: /reference/education
/cvapi/reference/education
This call returns the education reference table values.

Chapter Reference

GET: /reference/chapter
/cvapi/reference/chapter
This call returns the chapter reference table values.

Subscription Reference

GET: /reference/subscription
/cvapi/reference/subscription
This call returns the subscription reference table values.

Relationship Reference

GET: /reference/relationship
/cvapi/reference/relationship
This call returns the relationship reference table values.

Product Reference

GET: /reference/product
/cvapi/reference/product
This call returns the product reference table values.

Committee Positions Reference

GET: /reference/committeePositions
/cvapi/reference/committeePositions
This call returns the committee positions reference table values.

Communication Options Reference

GET: reference/communication
/cvapi/reference/communication
This call returns the Communication Options reference table values.

Events

Information about events. Eventcd vs sessionaltcd etc in the database. What are functions, speakers, what tables are used.

Upcoming Events

GET: /eventlist
Get a list of upcoming events, all events with a start date greater than today:
/cvapi/eventlist

Example Return: 

{
	"results": 1,
	"rows": [{
		"title": "2024 Test Conference",
		"eventcd": "240101-ANNUALCONFERE",
		"url": "240101-ANNUALCONFERE",
		"urloverride": "",
		"start": "2024-01-01",
		"end": "2024-01-31",
		"starttms": "8:00 AM",
		"endtms": "9:00 AM",
		"className": "program_CONFERENCE",
		"featured": "Y",
		"TN_image": "/cv5/cgi-bin/cvimage.dll/view?ENTITY=S&ENTITYCD=240101-ANNUALCONFERE&IMAGENAME=TN",
		"program": "CONFERENCE",
		"programName": "Conference ",
		"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
	}]
}

All Events

GET: /eventlistall
Get a list of all events in the current year:
/cvapi/eventlistall

Example Return: 

[{
	"title": "2024 Test Conference",
	"eventcd": "240101-ANNUALCONFERE",
	"url": "240101-ANNUALCONFERE",
	"urloverride": "",
	"start": "2024-01-01",
	"end": "2024-01-31",
	"starttms": "8:00 AM",
	"endtms": "9:00 AM",
	"className": "program_CONFERENCE",
	"featured": "Y",
	"program": "CONFERENCE",
	"programName": "Conference ",
	"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
},{
	"title": "2024 Test Webinar",
	"eventcd": "240101-WEBINAR",
	"url": "240101-WEBINAR",
	"urloverride": "",
	"start": "2024-02-01",
	"end": "2024-02-31",
	"starttms": "8:00 AM",
	"endtms": "9:00 AM",
	"className": "program_WEBINAR",
	"featured": "Y",
	"program": "WEBINAR",
	"programName": "Webinar",
	"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
	dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
	consequat."
}]

Event Information

GET: /eventinfo/{eventcd}
Get basic information about a specific event:
/cvapi/eventinfo/240101-ANNUALCONFERE

Example Return: 

{
	"EventCD":"240101-ANNUALCONFERE",
	"SessionCD":"163",
	"CompanyCD":"001",
	"ChapterCD":"",
	"ProgramCD":"CONFERENCE",
	"EventName":"2024 Test Conference",
	"EventDesc":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt .",
	"MarketingCity":"",
	"MarketingStateCD":"",
	"Status":"Open",
	"DayCount":"",
	"StartTime":"8:00 AM",
	"EndTime":"9:00 AM",
	"StartDate":"1/1/2024",
	"EndDate":"1/31/2024",
	"LastRegisterDate":"1/1/2024",
	"EarlyRegisterDate":"1/1/2023",
	"ViewOnlineFLG":"Y",
	"RegisterOnlineFLG":"Y",
	"MajorCategory":"",
	"MinorCategory":"",
	"CanCancelFLG":"Y",
	"LastCancelDate":"1/1/2024",
	"CancelFeeAmt":"0.00",
	"AttendeeMaxQTY":"99",
	"AttendeeMinQTY":"0",
	"LocationName":"",
	"LocationCD":"",
	"LocationPhone":"",
	"LocationContactName":"",
	"LocationContactPhone":"",
	"LocationFaxPhone":"",
	"LocationContactEmail":"",
	"LocationAddress1":"",
	"LocationAddress2":"",
	"LocationCity":"",
	"LocationStateCD":"",
	"LocationZip":"",
	"LocationCountry":"",
	"LocationRoomRate":"",
	"LocationMeetingRoom":"",
	"HTMLDescription":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
}

Event Attendees

GET: /eventAttendees/{eventcd}
Get a list of the attendees to an event:
/cvapi/eventAttendees/240101-ANNUALCONFERE

Example Return: 

{
	"results": 1,
	"rows": [{
		"ASSIGNEDSESSIONCD":"2752",
		"CUSTOMERCD":"360755",
		"FIRSTNAME":"Janice",
		"LASTNAME":"Chu",
		"ORGANIZATION":"TEST Bank",
		"JOBTITLE":"",
		"EMAIL":"test@testtesttest.com",
		"CITY":"Bethesda",
		"STATECD":"MD",
		"MEMBERTYPE":"General",
		"PRICETYPESTT":"MEM",
		"PAIDFLG":"Y",
		"CANCELLEDFLG":"N",
		"INVOICENUM":"7093",
		"SHOWDIRECTORYFLG":"Y",
		"CONFERENCEPROFILE":"",
		"CUSTOMERIMAGE":""
	}]
}

Event Functions

GET: /eventFunctions/{eventcd}
List functions from a specific event:
/cvapi/eventfunctions/240101-ANNUALCONFERE

Example Return: 

{
	"results": 2,
	"rows": [
		{
			"FUNCTIONCD": "AgEngage",
			"TITLE": "Agricultural & Environmental Engagement",
			"PRICEAMT": "0.00",
			"STARTDATE": "6/22/2023",
			"ENDDATE": "6/22/2023",
			"STARTTMS": "1:30 PM",
			"ENDTMS": "4:00 PM",
			"DESCRIPTION": "",
			"PARENTFUNCTION": "",
			"CHILDFUNCTION": "",
			"ONWEBFLG": "Y",
			"FEEBASEDFLG": "N",
			"MEMBERPRICEAMT": "0.00",
			"DISCOUNTPRICEAMT": "",
			"OTHERPRICEAMT": "",
			"LOCATION": "",
			"TRACK": ""
		},
		{
			"FUNCTIONCD": "Certs",
			"TITLE": "Distribution of Certificates & Adjournment",
			"PRICEAMT": "0.00",
			"STARTDATE": "6/22/2023",
			"ENDDATE": "6/22/2023",
			"STARTTMS": "4:00 PM",
			"ENDTMS": "4:30 PM",
			"DESCRIPTION": "",
			"PARENTFUNCTION": "",
			"CHILDFUNCTION": "",
			"ONWEBFLG": "Y",
			"FEEBASEDFLG": "N",
			"MEMBERPRICEAMT": "0.00",
			"DISCOUNTPRICEAMT": "",
			"OTHERPRICEAMT": "",
			"LOCATION": "",
			"TRACK": ""
		}
	]
}

Function Attendees

GET: /functionAttendees/{eventcd}
Get a list of attendees to a specific function of an event:
/cvapi/functionAttendees/240101-ANNUALCONFERE/FUNCTION1

Example Return: 

{
	"results": 1,
	"rows": [{
		"FUNCTIONCD":"FUNCTION1",
		"ASSIGNEDSESSIONCD":"2752",
		"CUSTOMERCD":"360755",
		"CUSTOMERNAME":"Chu, Janice",
		"PAIDFLG":"Y",
		"CANCELLEDFLG":"N"
	}]
}

Event Speakers

GET: /eventSpeakers/{eventcd}
Get speakers and function assignments:
/cvapi/eventSpeakers/240101-ANNUALCONFERE

Example Return: 

{
	"results": 1,
	"rows": [{
		"CUSTOMERCD":"1301",
		"PREFIX":"Mr.",
		"FIRSTNAME":"Richard",
		"LASTNAME":"Caldwell",
		"CITY":"Glenn Bernie",
		"STATECD":"MD",
		"ORGNAME":"Flagger Force",
		"ORGCD":"78",
		"JOBTITLE":"",
		"DEPARTMENT":"",
		"NOTE":""
	}]
}

Event Attendee Assignments

GET: /eventAttendee/{assignedsessioncd}
Get a list of enrolled functions for a given attendee:
/cvapi/eventAttendee/2752

Example Return: 

{
	"ASSIGNEDSESSIONCD":"2752",
	"CUSTOMERNAME":"Chu, Janice",
	"CUSTOMERCD":"360755",
	"EMAIL":"",
	"MEMBERTYPE":"General",
	"PRICETYPESTT":"MEM",
	"PAIDFLG":"Y",
	"CANCELLEDFLG":"N",
	"INVOICENUM":"7093",
	"FUNCTIONS":[{
		"FUNCTIONCD":"FUNCTION1",
		"TITLE":"New Years Party",
		"PRICEAMT":"50.00",
		"STARTDATE":"1/1/2024",
		"ENDDATE":"1/2/2024",
		"STARTTMS":"",
		"ENDTMS":"",
		"DESCRIPTION":"",
		"PARENTFUNCTION":"",
		"CHILDFUNCTION":"",
		"ONWEBFLG":"Y",
		"FEEBASEDFLG":"Y",
		"MEMBERPRICEAMT":"50.00",
		"DISCOUNTPRICEAMT":"",
		"OTHERPRICEAMT":"",
		"LOCATION":"",
		"TRACK":""
	}]
}

Mark an Attendee as Attended

GET: /attended/{assignedsessioncd}
Mark an individual as attended in the database for the event:
/cvapi/attended/2752

Members

Information about the Members in the database. These actions interact with the database CUSTOMER table. GET calls are used to retreive information from the database. POST calls are used to make updates to the CUSTOMER records. The Member List calls return a subset of the most frequently used fields for a customer record. A complete field list for customers can be found using the member information call for a specific member.

Member List

GET: /memberlist/{date/time_value}
Get a list of members that have been updated in the database since the date included in the API call:
/cvapi/memberlist/3-21-2023

Get a list of members that have been updated in the database today:
/cvapi/memberlist/getdate()

Get a list of members that have been updated in the database since yesterday (today's date -1):
/cvapi/memberlist/getdate()-1

Example Return: 

{
	"results": 1,
	"rows": [
	{
		"CUSTOMERCD":"360688",
		"CUSTOMERALT":"",
		"PREFIX":"",
		"FIRSTNAME":"Diana",
		"MI":"",
		"LASTNAME":"Sanabria Nieto",
		"SUFFIX":"",
		"EMAIL":"dsanabria@euclidtechnology.com",
		"COMPANY":"",
		"JOBTITLE":"",
		"DEPARTMENT":"",
		"ADDRESS1":"",
		"ADDRESS2":"",
		"CITY":"Bethesda",
		"STATECD":"MD",
		"ZIP":"20814",
		"COUNTRY":"",
		"PHONE":"",
		"ISMEMBER":"Y",
		"MEMBERTYPE":"General",
		"MEMBERSTATUS":"PendingTwo",
		"JOINDATE":"",
		"EXPIREDATE":"",
		"UPDATETMS":"7/24/2023 11:01:52 AM"
	}]
}

Member Info

GET: /memberinfo/{customercd}
Get full information for a specific member:
/cvapi/memberinfo/1001

Example Return: 

{
	"CUSTOMERCD":"1001",
	"CUSTOMERALT":"5177",
	"PREFIX":"Mr.",
	"FIRSTNAME":"Alexander",
	"MIDDLEINITIAL":"L",
	"MIDDLENAME":"L.",
	"LASTNAME":"Aab",
	"PREFNAME":"",
	"SUFFIX":"",
	"DESIGNATIONLST":"",
	"LONGSALUTATION":"Dear Mr. Aab",
	"FULLNAME":"Aab, Alexander",
	"ORGCD":"226",
	"ORGNAME":"Abbott Laboratories",
	"JOBTITLE":"Staff Accountant",
	"DEPARTMENT":"Finance",
	"ADDRESSTYPE":"Work",
	"ADDRESS1":"1315 I St",
	"ADDRESS2":"",
	"ADDRESS3":"",
	"CITY":"Sacramento",
	"STATECD":"CA",
	"ZIP":"95814-2915",
	"PROVINCE":"",
	"COUNTRY":"",
	"COUNTY":"SAC",
	"ADDRCONGRESSDISTRICT":"06",
	"ADDRWARD":"",
	"ADDRPRECINCT":"",
	"WORKPHONE":"(333) 983-8383",
	"WORKPHONEEXT":"123321",
	"PAGERPHONE":"",
	"MOBILEPHONE":"",
	"FAXPHONE":"",
	"ALTFAXPHONE":"",
	"HOMEPHONE":"(888) 888-8888",
	"ALTPHONE":"",
	"ALTPHONEEXT":"",
	"EMAIL":"dfernandez@euclidtechnology.com",
	"ALTEMAIL":"",
	"ALT2EMAIL":"",
	"WWWADDRESS":"",
	"ALTADDRESS1":"",
	"ALTADDRESS2":"",
	"ALTADDRESS3":"",
	"ALTCITY":"",
	"ALTSTATE":"KS",
	"ALTZIP":"k",
	"ALTPROVINCE":"",
	"ALTCOUNTRY":"Kenya",
	"ALTCOUNTY":"",
	"NOMAILFLG":"N",
	"NOSELLFLG":"Y",
	"NOCALLFLG":"N",
	"NOEMAILFLG":"N",
	"NOFAXFLG":"N",
	"NOWEBFLG":"Y",
	"ISEXHIBITORFLG":"N",
	"ISSPONSORFLG":"Y",
	"ISMEMBERFLG":"Y",
	"MEMBEROPTIONSLST":"CTR,DCL,DOC,TCL",
	"JOURNALFLG":"Y",
	"SPONSORCD":"",
	"SPONSORNAME":"",
	"JOINDATE":"11/1/2017",
	"TERMINATIONDATE":"8/31/2017",
	"DROPDATE":"",
	"FIRSTJOINDATE":"",
	"CHAPTERID":"CO",
	"ALTCHAPTERCD":"AA",
	"CUSTOMERTYPE":"Prospect",
	"STATUSSTT":"Current",
	"CUSTOMERCLASSSTT":"",
	"GENDER":"M",
	"SPOUSENAME":"",
	"ETHNICITY":"Hispanic",
	"BIRTHDATE":"12/12/1947",
	"DECEASEDDATE":"",
	"HEIGHT":"BOTHMATCH",
	"WEIGHTQTY":"",
	"EYECOLOR":"Blue",
	"HAIRCOLOR":"",
	"BIRTHCITY":"",
	"BIRTHSTATECD":"",
	"POLITICALPARTY":"",
	"INCOMEAMT":"",
	"HOUSEHOLDQTY":"",
	"INDUSTRY":"ATTORNEY",
	"OCCUPATIONCD":"COO",
	"SCHOOLATTENDED":"",
	"NATIONALITY":"",
	"VOTEHISTORY":"",
	"EDUCATIONCDLST":"",
	"INTERESTCDLST":"GEN,AUT",
	"SKILLCDLST":"",
	"GRADYEAR":"",
	"WEALTHAMT":"",
	"RESIDENCELENGTH":"",
	"HASCHILDRENFLG":"N",
	"HASPETSFLG":"N",
	"PETNAMES":"",
	"MARITALSTT":"",
	"CHILDRENNAMES":"",
	"UDEF1QTY":"63",
	"UDEF2QTY":"36",
	"UDEF3QTY":"",
	"UDEF4QTY":"",
	"UDEF5QTY":"",
	"UDEF1AMT":"",
	"UDEF2AMT":"",
	"UDEF3AMT":"",
	"UDEF4AMT":"",
	"UDEF5AMT":"",
	"UDEF1TXT":"",
	"UDEF2TXT":"",
	"UDEF3TXT":"",
	"UDEF4TXT":"",
	"UDEF5TXT":"",
	"LICENSEDATE1":"5/10/1974",
	"LICENSEDATE2":"5/10/1974",
	"ISTRAINERFLG":"N",
	"HEADOFHOUSEHOLDFLG":"N",
	"REGIONCD1":"",
	"REGIONCD2":"",
	"CUSTOMADDRESSFLG":"N",
	"GOVTREPFLG":"N",
	"ADDRESSFLOWFLG":"N",
	"SYSTEMDATE1":"",
	"SYSTEMDATE2":"",
	"SYSTEMQTY1":"0",
	"SYSTEMQTY2":"0",
	"USESUFFIXFLG":"N",
	"LRSONLYFLG":"N",
	"ENTERTMS":"",
	"ENTERUSERCD":"",
	"UPDATEUSERCD":"JFREY",
	"UPDATETMS":"1/20/2022 5:53:53 PM"
}

Communnication Options

Information about the communication options that have been selected by the member for the receipt of emails. These actions interact with the database CUSTOMER and COMMUNICATION_OPTIONS tables. GET calls are used to retreive information from the database.

Communication Options Reference

GET: reference/communication
Get reference information for the Communication Options:
/cvapi/reference/communication

Example Return: 

{
	"count":3,
	"fields":[
		{
	"CODENUM": "1033",
	"CODE": "NEWS01",
	"DESCRIPTION": "Newsletter",
	"GROUPNAME": "Newsletter"
}

,{
	"CODENUM": "1034",
	"CODE": "ALERT01",
	"DESCRIPTION": "Security Alert",
	"GROUPNAME": "Security Alert"
}

,{
	"CODENUM": "1036",
	"CODE": "MKT01",
	"DESCRIPTION": "Recent Product Updates",
	"GROUPNAME": "Recent Product Updates"
}
	]
}

Member Communication Options

GET: /commoptions/{customercd}
Get full information for a specific member:
/cvapi/commoptions/1001

Example Return: 

{
	"count":2,
	"fields":[
		{
	"KEYNUM": "1",
	"OWNERCD": "37",
	"OWNERTYPECD": "I",
	"COMM_CD": "MKT01",
	"COMM_ALLOWEDFLG": "N",
	"COMM_REASON": "",
	"ENTERUSERCD": "CVINAL",
	"ENTERTMS": "3/14/2018 12:22:20 PM",
	"UPDATEUSERCD": "CVINAL",
	"UPDATETMS": "3/14/2018 12:23:36 PM",
	"CONFIRMEDUSERCD": "CVINAL",
	"CONFIRMEDTMS": "3/14/2018 12:23:36 PM"
}

,{
	"KEYNUM": "2",
	"OWNERCD": "37",
	"OWNERTYPECD": "I",
	"COMM_CD": "MKT02",
	"COMM_ALLOWEDFLG": "N",
	"COMM_REASON": "",
	"ENTERUSERCD": "CVINAL",
	"ENTERTMS": "3/14/2018 12:22:20 PM",
	"UPDATEUSERCD": "",
	"UPDATETMS": "",
	"CONFIRMEDUSERCD": "CVINAL",
	"CONFIRMEDTMS": "3/14/2018 12:23:36 PM"
}
	]
}

List Communication Options

GET: /listcommoptions/{COMM_CD}
Get a list of members and emails for the accounts that are subscribed to the specific communication list:
/cvapi/listcommoptions/NEWS01

Example Return: 

{
{
	"count":2,
	"fields":[
		{
	"COMM_CD": "NEWS01",
	"DESCRIPTION": "Newsletter",
	"CUSTOMERCD": "300114",
	"EMAIL": "name@domain.com"
}

,{
	"COMM_CD": "NEWS01",
	"DESCRIPTION": "Newsletter",
	"CUSTOMERCD": "300471",
	"EMAIL": "smith@domain.com"
}
	]
}

Organizations

Information about the Organizations in the database. These actions interact with the database ORGANIZATION table. GET calls are used to retreive information from the database. POST calls are used to make updates to the ORGANIZATION records. The Organization List calls return a subset of the most frequently used fields for a organization record. A complete field list for an organization can be found using the organization information call for a specific organization.

Organization List

GET: /orglist/{date/time_value}
Get a list of organizations that have been updated in the database since the date included in the API call:
/cvapi/orglist/3-21-2023

Get a list of organizations that have been updated in the database today:
/cvapi/orglist/getdate()

Get a list of organizations that have been updated in the database since yesterday (today's date -1):
/cvapi/orglist/getdate()-1

Example Return: 

{
	"results": 1,
	"rows": [
	{
		"ORGCD":"1254",
		"ORGALTCD":"",
		"ORGNAME":"Test Company 3",
		"ORGPARENTCD":"",
		"ORGPARENTNAME":"",
		"ORGTYPE":"General",
		"ISEXHIBITORFLG":"N",
		"ISSPONSORFLG":"N",
		"ISMEMBERFLG":"N",
		"ISVENDORFLG":"N",
		"ISTAXABLEFLG":"Y",
		"ENTERTMS":"6/7/2023",
		"ENTERUSERCD":"WEBUSER",
		"UPDATEUSERCD":"DSANABRIA",
		"UPDATETMS":"7/24/2023 11:11:59 AM"
	}]
}

Organization Info

GET: /orginfo/{orgcd}
Get full information for a specific organization:
/cvapi/orginfo/4

Example Return: 

{
	"ORGCD":"4",
	"ORGALTCD":"",
	"ORGNAME":"MemberConnection",
	"ORGPARENTCD":"",
	"ORGPARENTNAME":"",
	"ORGTYPE":"Associate",
	"UNITSQTY":"",
	"PROPERTYTYPE":"Corporation",
	"PREFIX":"",
	"CONTACTNAME":"Nasser Qadri",
	"LONGSALUTATION":"Dear  Qadri",
	"FIRSTNAME":"Nasser",
	"MIDDLEINITIAL":"",
	"LASTNAME":"Qadri",
	"JOBTITLE":"",
	"DEPARTMENT":"",
	"ADDRESSTYPE":"",
	"ADDRESS1":"8120 woodmont Ave",
	"ADDRESS2":"",
	"ADDRESS3":"",
	"CITY":"Bethesda",
	"STATECD":"MD",
	"ZIP":"20814",
	"PROVINCE":"",
	"COUNTRY":"",
	"COUNTY":"",
	"ADDRWARD":"",
	"ADDRPRECINCT":"",
	"WORKPHONE":"(301) 657-8089",
	"WORKPHONEEXT":"",
	"PAGERPHONE":"",
	"MOBILEPHONE":"",
	"FAXPHONE":"",
	"ALTFAXPHONE":"",
	"ALTCONTACTNAME":"",
	"ALTJOBTITLE":"",
	"ALTCONTACTPHONE":"",
	"HOMEPHONE":"(240) 711-2211",
	"ALTPHONE":"",
	"ALTPHONEEXT":"",
	"EMAIL":"nasserqadri@thesmartassoc.com",
	"WWWADDRESS":"www.smart.int",
	"ALTADDRESSTYPE":"",
	"ALTADDRESS1":"",
	"ALTADDRESS2":"",
	"ALTADDRESS3":"",
	"ALTCITY":"",
	"ALTSTATE":"",
	"ALTZIP":"",
	"ALTPROVINCE":"",
	"ALTCOUNTRY":"",
	"ALTCOUNTY":"",
	"NOMAILFLG":"N",
	"NOSELLFLG":"N",
	"NOCALLFLG":"N",
	"NOEMAILFLG":"N",
	"NOFAXFLG":"N",
	"NOWEBFLG":"N",
	"ISEXHIBITORFLG":"N",
	"ISSPONSORFLG":"N",
	"ISMEMBERFLG":"Y",
	"ISVENDORFLG":"",
	"ISTAXABLEFLG":"Y",
	"MEMBEROPTIONS":"",
	"JOURNALFLG":"N",
	"SPONSORCD":"",
	"SPONSORNAME":"",
	"JOINDATE":"11/21/2016",
	"TERMINATIONDATE":"",
	"DROPDATE":"",
	"FIRSTJOINDATE":"",
	"CHAPTERID":"",
	"ALTCHAPTERCD":"",
	"MEMBERTYPE":"",
	"STATUSSTT":"Active",
	"CUSTOMERCLASSSTT":"",
	"COUPONSAMT":"",
	"BILLPERIODNUM":"",
	"CONTACTSTT":"Any Contact",
	"MEMBERCOUNTQTY":"",
	"ORGCLASSSTT":"Gold",
	"INFOSTATUSSTT":"Valid",
	"BILLTOSTT":"O",
	"LASTACTION":"",
	"LASTACTIONDATE":"",
	"NEXTACTION":"",
	"NEXTACTIONDATE":"",
	"EMPLOYEEQTY":"",
	"INCOMEAMT":"",
	"ORGREVENUEAMT":"60000000.00",
	"SALUTATION":"Mr.",
	"TOTALINVOICEAMT":"",
	"TOTALPAIDAMT":"",
	"TOTALBALANCEAMT":"",
	"INDUSTRY":"",
	"POLITICALPARTY":"",
	"ORGCOMMENT":"",
	"INTERESTCDLST":"",
	"SKILLCDLST":"",
	"PRODUCTCDLST":"",
	"BILLTOADDRESS":"",
	"CUSTOMERCDLINK":"9",
	"CUSTOMERNAMELINK":"",
	"DUPKEY":"MEMBERCONNECTION20814",
	"UDEF1QTY":"",
	"UDEF2QTY":"",
	"UDEF3QTY":"",
	"UDEF4QTY":"",
	"UDEF5QTY":"",
	"UDEF1AMT":"",
	"UDEF2AMT":"",
	"UDEF3AMT":"",
	"UDEF4AMT":"",
	"UDEF5AMT":"",
	"UDEF1TXT":"",
	"UDEF2TXT":"",
	"UDEF3TXT":"",
	"UDEF4TXT":"TSA",
	"UDEF5TXT":"",
	"CONTRIBREVENUEAMT":"",
	"GOVTREVENUEAMT":"",
	"GOVTREVENUEPCT":"",
	"ADMINCOSTAMT":"",
	"ADMINCOSTPCT":"",
	"SERVICECOSTAMT":"",
	"SERVICECOSTPCT":"",
	"TAXEXEMPTCD":"",
	"FEDEMPLOYERCD":"",
	"LICENSEDATE1":"",
	"LICENSEDATE2":"",
	"ISTRAINERFLG":"",
	"ORGLEGALNAME":"",
	"NONDISCFLG":"N",
	"TOLLFREEPHONE":"",
	"OTHERREVENUEAMT":"",
	"FYENDDATE":"",
	"CONTRIBINDREVENUEAMT":"",
	"ORGEXPENSEAMT":"",
	"MKTCOSTAMT":"",
	"ALTADDRESSCRC":"",
	"ALTADDRESSDPC":"",
	"PRIMARYCONTACTCD":"",
	"LICENSESTATECD":"",
	"VENDORCD":"",
	"NOTIFIEDBYSTT":"",
	"APPEALCD":"",
	"PARENTORGADDRESS":"",
	"DONATIONQTY":"",
	"DONATIONAMT":"",
	"DONORCLASSSTT":"",
	"DONORPROBABILITYPCT":"",
	"DONORSTT":"",
	"DONORNEXTGIFTDATE":"",
	"DONORNEXTGIFTAMT":"",
	"DONORNEXTGIFTTYPE":"",
	"DONORACKNOWLEDGEFLG":"",
	"ALTCONTACTEMAIL":"",
	"BILLTOCD":"",
	"LINKEDCHAPTERCD":"",
	"WEBUSERID":"",
	"MMCSUMMARY":"",
	"ALTCUSTOMERCDLINK":"",
	"ALTINFOSTATUSSTT":"",
	"AUTOEMAILCOPYTO":"",
	"UDEF_SYS_ENGAGE1QTY":"14",
	"CUSTOMADDRESSFLG":"",
	"GOVTREPFLG":"",
	"ADDRESSFLOWFLG":"",
	"SYSTEMDATE1":"",
	"SYSTEMDATE2":"",
	"SYSTEMQTY1":"",
	"SYSTEMQTY2":"",
	"USESUFFIXFLG":"",
	"MAXMAILINGQTY":"",
	"ENTERTMS":"4/30/2010",
	"ENTERUSERCD":"EUCLID",
	"UPDATEUSERCD":"DAN",
	"UPDATETMS":"11/21/2016 3:24:07 PM"
}

Committees

Information about the Committees in the database. These actions interact with the database COMMITTEE and INDCOMMITTEE tables. GET calls are used to retreive information from the database. The Committee List calls returns a list of Committees. The Committee member calls returns the members of a specific committee.

Committee List

GET: /committeelist
Get a list of committees that are currently active. call:
/cvapi/committeelist

Example Return: 

{
	"results": 1,
	"rows": [{
		"COMMITTEECD":"AWARDS",
		"NAME":"Awards Committee",
		"TYPE":"Award",
		"CHAIRPERSON":"Matt Snyder",
		"STARTDATE":"1/1/2022",
		"ENDDATE":"",
		"STATUS":"Active",
		"PURPOSE":"This committee manages all awards meetings",
		"URL":""
	}]
}

Committee Members

GET: /committeemembers/{committeecd}
Get full information for a specific organization:
/cvapi/committeemembers/AWARDS

Example Return: 

{
	"results": 1,
	"rows": [{
		"COMMITTEECD":"AWARDS",
		"CUSTOMERCD":"10",
		"NAME":"Antonoff, Dan",
		"ORGNAME":"Best Nonprofit",
		"LOCATION":"Bethesda, MD",
		"POSITION":"Co-Chair",
		"JOINDATE":"8/4/2015",
		"TERMINATIONDATE":"8/4/2016",
		"STATUS":"Active",
		"PROFILEIMG": "/cv5/cgi-bin/cvimage.dll/view?ENTITY=MEM&ENTITYCD=10"
	}]
}

Subscriptions

Information about the Subscriptions in the database. These actions interact with the database SUBSCRIPTION table.

Subscription List

GET: /subscriptionList/{CUSTOMERTYPECD}/{CUSTOMERCD}
Get a list of all active subscriptions a member has :
/cvapi/subscriptionList/I/100000002

Where CUSTOMERCD is the CUSTOMERCD or ORGCD. If it is an organization the CUSTOMERTYPECD = O and if it is an individual the CUSTOMERTYPECD = I with an expiration date in the future.

Example Return: 

{
	"results": 1,
	"rows": [{
		"SUBSCRIPTIONNUM": "15",
		"SUBSCRIPTIONNAME": "ASSOCIATE",
		"CUSTOMERCD": "100000002",
		"CUSTOMERTYPECD": "I",
		"PAYEETYPECD": "I",
		"PAYEECD": "100000002",
		"PRICEAMT": "0.00",
		"DUEDATE": "1/10/2024",
		"STARTDATE": "1/10/2024",
		"EXPIRATIONDATE": "1/10/2025",
		"PAIDFLG": "Y",
		"CANCELLEDFLG": "N",
		"CANCELDATE": "",
		"PAIDDATE": "",
		"BILLPERIODNUM": "1",
		"PERIODQTY": "1",
		"ACKNOWLEDGEDFLG": "N",
		"ACKNOWLEDGEDATE": "",
		"LASTRENEWALDATE": "",
		"STARTDATEORIGINAL": "",
		"ISRENEWED": "N"
	}]
}

Membership List

GET: /membershipList/{CUSTOMERTYPECD}/{CUSTOMERCD}
Get a list of all active memberships a member has :
/cvapi/membershipList/I/100000002

Where CUSTOMERCD is the CUSTOMERCD or ORGCD. If it is an organization the CUSTOMERTYPECD = O and if it is an individual the CUSTOMERTYPECD = I with an expiration date in the future and UDEF1TXT = Membership.

Example Return: 

{
	"results": 1,
	"rows": [{
		"SUBSCRIPTIONNUM": "15",
		"SUBSCRIPTIONNAME": "ASSOCIATE",
		"CUSTOMERCD": "100000002",
		"CUSTOMERTYPECD": "I",
		"PAYEETYPECD": "I",
		"PAYEECD": "100000002",
		"PRICEAMT": "0.00",
		"DUEDATE": "1/10/2024",
		"STARTDATE": "1/10/2024",
		"EXPIRATIONDATE": "1/10/2025",
		"PAIDFLG": "Y",
		"CANCELLEDFLG": "N",
		"CANCELDATE": "",
		"PAIDDATE": "",
		"BILLPERIODNUM": "1",
		"PERIODQTY": "1",
		"ACKNOWLEDGEDFLG": "N",
		"ACKNOWLEDGEDATE": "",
		"LASTRENEWALDATE": "",
		"STARTDATEORIGINAL": "",
		"ISRENEWED": "N"
	}]
}

Donation List

GET: /donationList/{CUSTOMERTYPECD}/{CUSTOMERCD}
Get a list of all donations a member has :
/cvapi/donationList/I/100000002

Where CUSTOMERCD is the CUSTOMERCD or ORGCD. If it is an organization the CUSTOMERTYPECD = O and if it is an individual the CUSTOMERTYPECD = I with a UDEF1TXT = Donation.

Example Return: 

{
	"results": 1,
	"rows": [{
		"SUBSCRIPTIONNUM": "15",
		"SUBSCRIPTIONNAME": "ASSOCIATE",
		"CUSTOMERCD": "100000002",
		"CUSTOMERTYPECD": "I",
		"PAYEETYPECD": "I",
		"PAYEECD": "100000002",
		"PRICEAMT": "0.00",
		"DUEDATE": "1/10/2024",
		"STARTDATE": "1/10/2024",
		"EXPIRATIONDATE": "1/10/2025",
		"PAIDFLG": "Y",
		"CANCELLEDFLG": "N",
		"CANCELDATE": "",
		"PAIDDATE": "",
		"BILLPERIODNUM": "1",
		"PERIODQTY": "1",
		"ACKNOWLEDGEDFLG": "N",
		"ACKNOWLEDGEDATE": "",
		"LASTRENEWALDATE": "",
		"STARTDATEORIGINAL": "",
		"ISRENEWED": "N"
	}]
}