ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

FollowUp

API	Description
GET associations({associationId})/Communications({correspondenceId})/follow-ups	this method gets a list of follow-ups for a correspondence
GET associations({associationId})/Communications/follow-ups	this method gets a list of follow-ups for an association
POST associations({associationId})/Communications/follow-ups	this method inserts a follow-up Entry Resource

CheckIn

API	Description
POST associations({associationId})/events({eventId})/CheckIns	Method to create a new CheckIn
POST associations({associationId})/News({newsId})/CheckIns	Method to create a new CheckIn
POST associations({associationId})/Jobs({jobId})/CheckIns	Method to create a new CheckIn
POST associations({associationId})/members({memberId})/CheckIns	Method to create a new CheckIn
POST associations({associationId})/Marketplace/Items({marketplaceItemId})/CheckIns	Method to create a new CheckIn
GET associations({associationId})/representatives({representativeId})/CheckIns	Method to get a representative's check-ins

JobGroups

API	Description
GET associations({associationId})/jobs/groups	No documentation available.
PUT associations({associationId})/jobs/groups({groupId})	No documentation available.
POST associations({associationId})/jobs/groups	No documentation available.
DELETE associations({associationId})/jobs/groups({groupId})	No documentation available.

EventLocation

API	Description
GET associations({associationId})/events({eventId})/location	Method to get an event location
GET associations({associationId})/events/location	Method to get an all event locations

Terminology

API	Description
GET associations({associationId})/legacyterminology	Returns terminology values from old terminology table.
GET associations({associationId})/terminology	Gets terminology for a association

StatusUpdateComment

API	Description
GET associations({associationId})/status({statusUpdateId})/comments	Method to get all comments for a status update
POST associations({associationId})/status({statusUpdateId})/comments	Method to post a new comment
DELETE associations({associationId})/status({statusUpdateId})/comments({commentId})	Method to delete a comment

Categories

API	Description
GET associations({associationId})/categories({categoryId})?memberType={memberType}	Method to get some data about a category
GET associations({associationId})/categories?memberType={memberType}	Method to get data about categories at a association
GET associations({associationId})/members({memberId})/categories	Method to get category information about a member
PUT associations({associationId})/categories({categoryId})	Method to modify a category

Associations

API	Description
GET associations({associationId})	No documentation available.
GET associations	No documentation available.
GET associations({associationId})/SoftwarePackageTypes	No documentation available.
POST associations({associationId})/image	No documentation available.
GET associations({associationId})/micsettings	Method to get the MIC settings for an association
GET associations({associationId})/memberareasettings	Method to get the MIC settings for an association
GET associations({associationId})/micpermissions	Method to get the MIC settings for an association
GET associations({associationId})/memberareapermissions	Method to get the MIC settings for an association
GET associations({associationId})/storesettingsandfees	Method to get the store fees and settings (e.g. hotdeal fees)

RepresentativeRelationship

API	Description
GET associations({associationId})/representatives/relationships/representatives	Method to get a representative's followed representatives
POST associations({associationId})/representatives({startRepresentativeId})/relationships({relationshipType})/representatives({endRepresentativeId})	Method to add a relationship between two representatives
DELETE associations({associationId})/representatives({startRepresentativeId})/relationships({relationshipType})/representatives({endRepresentativeId})	Method to delete a relationship between two representatives

GroupMember

API	Description
GET associations({associationId})/groups({groupId})/members	Gets all group members in a group
GET associations({associationId})/groups/members	Gets all group members in all group
POST associations({associationId})/groups({groupId})/members	Posts a group member in a group
POST associations({associationId})/groups({groupId})/manymembers	Posts group members into a group
PUT associations({associationId})/groups({groupId})/members({groupMemberId})	Method to modify a group member
DELETE associations({associationId})/groups({groupId})/members({groupMemberId})	Method to delete a group member

Communication

API	Description
GET associations({associationId})/members({memberId})/Communications	this method gets a list of correspondence for a member
GET associations({associationId})/Communications({correspondenceId})	this method gets a Communication Entry Resource
POST associations({associationId})/Communications	this method inserts a Communication Entry Resource
GET associations({associationId})/MemberSalesStages	Method to get sales stages for an association

CategoryAttributes

API	Description
GET associations({associationId})/categories/groups/attributes	No documentation available.
POST associations({associationId})/categories({categoryId})/groups({groupId})/attributes	No documentation available.
PUT associations({associationId})/categories({categoryId})/groups({groupId})/attributes({attributeId})	No documentation available.
DELETE associations({associationId})/categories({categoryId})/groups({groupId})/attributes({attributeId})	No documentation available.

QuickLinkCategories

API	Description
GET associations({associationId})/quicklinkcategories({categoryId})	No documentation available.
GET associations({associationId})/quicklinkcategories	No documentation available.

EventFeeds

API	Description
GET associations({associationId})/events/feeds	No documentation available.
GET associations({associationId})/events/feeds({identifier})	No documentation available.
POST associations({associationId})/events/feeds	No documentation available.
PUT associations({associationId})/events/feeds({identifier})	No documentation available.
DELETE associations({associationId})/events/feeds({identifier})	No documentation available.

JobGroupItems

API	Description
GET associations({associationId})/jobs/groups/attributes	No documentation available.
POST associations({associationId})/jobs/groups({groupId})/attributes	No documentation available.
PUT associations({associationId})/jobs/groups({groupId})/attributes({attributeId})	No documentation available.
DELETE associations({associationId})/jobs/groups({groupId})/attributes({attributeId})	No documentation available.

MemberDetails

API	Description
GET associations({associationId})/members({memberId})/details	This method takes a member identifier and returns a single details object to be serialized
GET associations({associationId})/members/details	This method takes a association identifier and returns a bunch of details objects to be serialized
GET associations({associationId})/members/details/categories	Method to retrieve all members and all of their categories
PUT associations({associationId})/members({memberId})/details	This method takes a association identifier and returns a bunch of details objects to be serialized

Demo

API	Description
POST Demo/Request	No documentation available.

RepresentativeDetails

API	Description
GET associations({associationId})/members({memberId})/representatives({representativeId})/details	This method takes a member identifier and returns a representative details object to be serialized
PUT associations({associationId})/members({memberId})/representatives({representativeId})/details	No documentation available.

EReferral

API	Description
POST associations({associationId})/ereferral	This method takes in lots of data and sends out a eReferral

AttributeGroups

API	Description
GET associations({associationId})/categories/groups	No documentation available.
GET associations({associationId})/categories({categoryId})/groups	No documentation available.
GET associations({associationId})/categories({categoryId})/groups({groupId})	No documentation available.
GET associations({associationId})/members({memberId})/categories/groups	No documentation available.
POST associations({associationId})/categories({categoryId})/groups	No documentation available.
PUT associations({associationId})/categories({categoryId})/groups({groupId})	No documentation available.
DELETE associations({associationId})/categories({categoryId})/groups({groupId})	No documentation available.

Marketplace

API	Description
GET associations({associationId})/Marketplace/Items	this method gets a bunch of marketplace items
GET associations({associationId})/Marketplace/Items({itemId})	this method gets a marketplace item
POST associations({associationId})/Marketplace/Items	Method to add a new marketplace item
PUT associations({associationId})/Marketplace/Items({itemId})	Method to approve or disable a marketplace item

Job

API	Description
GET associations({associationId})/Jobs	This method gets a bunch of jobs
GET associations({associationId})/Jobs({itemId})	This method gets a Job
GET associations({associationId})/Jobs/categories	This method gets a bunch of job categories
POST associations({associationId})/Jobs	Method to add a new job
PUT associations({associationId})/Jobs({itemId})	This method updates a Job
POST associations({associationId})/Jobs({itemId})/images	Method to post images to a job

MemberMisc

API	Description
GET associations({associationId})/members/basic	No documentation available.
GET associations({associationId})/categories({categoryId})/members	No documentation available.
GET associations({associationId})/quicklinks({quickLinkId})/members	No documentation available.
GET associations({associationId})/members/levels	No documentation available.
GET associations({associationId})/members/weblevels	No documentation available.
GET associations({associationId})/members/status	No documentation available.
GET associations({associationId})/members/socialnetworks	No documentation available.
GET associations({associationId})/members/types	No documentation available.
GET associations({associationId})/members/status/counts	No documentation available.
POST associations({associationId})/members({memberId})/image/{imageType}	No documentation available.
GET associations({associationId})/poi({poiId})/members	Method to get members by point of interest
GET associations({associationId})/members/customfields	Method to get a member's custom fields
GET associations({associationId})/members({memberId})/customfields	Method to get a member's custom fields

Group

API	Description
GET associations({associationId})/groups	Gets all groups in an association
GET associations({associationId})/groups/members/types	Gets all group member types
GET associations({associationId})/groups/types	Method to get group types
POST associations({associationId})/groups	Method to create a group

EventRegistration

API	Description
GET associations({associationId})/events/registrations({registrationId})	Method to get information about a registration
PUT associations({associationId})/events/registrations({registrationId})	Method to put information about a registration. Right now it is just for payment.

MarketplaceMisc

API	Description
GET associations({associationId})/Marketplace/Types	Method to get the available types of marketplace items
POST associations({associationId})/Marketplace/Items({itemId})/logo	Method to post images to a marketplace item

RepresentativeMisc

API	Description
GET associations({associationId})/representatives({representativeId})/displaypreferences	Method to get a representative's display preferences
POST associations({associationId})/members({memberId})/representatives({representativeId})/image	Method to post an image to a representative
GET associations({associationId})/representatives/basic	Method to get basic information about representatives
GET associations({associationId})/members({memberId})/representatives	Method to find representative data my member id
GET associations({associationId})/representatives({representativeId})/permissionsets	Method to get a representative's display preferences
GET associations({associationId})/representatives({representativeId})/customfields	Method to get a representative's custom fields
GET associations({associationId})/representatives/customfields	Method to get all representative's custom fields
PUT associations({associationId})/representatives({representativeId})/customfields({customFieldId})	Method to update a representative's custom fields

MemberPhoto

API	Description
GET associations({associationId})/members({memberId})/photos	Method to get a member's photo gallery photos
GET associations({associationId})/members/photos	No documentation available.
GET associations({associationId})/members({memberId})/photos({photoId})	No documentation available.
POST associations({associationId})/members({memberId})/photos	No documentation available.
DELETE associations({associationId})/members({memberId})/photos({photoId})	No documentation available.

EventDetail

API	Description
GET associations({associationId})/events/details	Method to get all event details
GET associations({associationId})/events({eventId})/details	Method to get details for an event
POST associations({associationId})/events/details	Method to post an event with details

AssociationStatistics

API	Description
GET associations({associationId})/statistics	Gets available statistics for the given association

Events

API	Description
GET associations({associationId})/members({memberId})/events({eventId})	Method to get an event
GET associations({associationId})/events({eventId})	Method to get an event
GET associations({associationId})/events	Method to get events
POST associations({associationId})/events	Method to post an event
PUT associations({associationId})/events({eventId})	Method to update an event

Advertisement

API	Description
GET associations({associationId})/Advertisements	this method gets a bunch of Advertisements
GET associations({associationId})/Advertisements({itemId})	this method gets a Advertisement
PUT associations({associationId})/Advertisements({itemId})	This method updates an advertisement
PUT associations({associationId})/Advertisements({itemId})/image	Method to change a banner ad image

MemberApplication

API	Description
GET associations({associationId})/members/applications	Method to get all member applications
PUT associations({associationId})/members/applications({applicationId})	Method to update a member application

ItemsRead

API	Description
PUT associations({associationId})/member/read	Method to PUT an item read
PUT associations({associationId})/representative/read	Method to PUT an item read
GET associations({associationId})/representative({representativeId})/unread	Method to get count of unread items

Benefits

API	Description
GET associations({associationId})/members({memberId})/benefits	this method gets a list of benefits by member id
POST associations({associationId})/members({memberId})/benefits	No documentation available.
GET associations({associationId})/members({memberId})/benefits({benefitId})	this method gets a list of benefits by member id
POST associations({associationId})/members({memberId})/benefits({benefitId})	No documentation available.
PUT associations({associationId})/members({memberId})/benefits({benefitId})	No documentation available.
DELETE associations({associationId})/members({memberId})/benefits({benefitId})	No documentation available.

MemberAttributes

API	Description
PUT associations({associationId})/members({memberId})/categories/groups/attributes({attributeId})	No documentation available.
PUT associations({associationId})/members({memberId})/categories/groups({groupId})	No documentation available.

Representatives

API	Description
POST associations({associationId})/members({memberId})/representatives({representativeId})	Method to create a new representative
PUT associations({associationId})/members({memberId})/representatives({representativeId})	Method to modify a representative. Currently this method only moves a representative from one member to another.
POST associations({associationId})/representatives({representativeId})	Method to create a new representative
PUT associations({associationId})/representatives({representativeId})	Method to modify a representative. Currently this method only moves a representative from one member to another.
GET associations({associationId})/representatives	No documentation available.
POST associations({associationId})/representatives	Method to create a new representative

EventMisc

API	Description
GET associations({associationId})/members({memberId})/events	Method to get events by member
GET associations({associationId})/events/types	Method to get event types
GET associations({associationId})/events/status	Method to get event status types
POST associations({associationId})/events({eventId})/mainimage	Method to post images to an event
POST associations({associationId})/events({eventId})/searchengineicon	Method to post images to an event
POST associations({associationId})/events({eventId})/gallery	Method to post images to an event

MemberNotes

API	Description
POST associations({associationId})/members({memberId})/notes({noteId})	this method takes in some data and creates a new note and returns the new note
POST associations({associationId})/members({memberId})/notes	this method takes in some data and creates a new note and returns the new note
GET associations({associationId})/notes	this method takes a association id and retrieves the corresponding notes

Members

API	Description
POST associations({associationId})/members({memberId})	No documentation available.
GET associations({associationId})/members	No documentation available.
POST associations({associationId})/members	No documentation available.

Charts

API	Description
GET associations({associationId})/charts({requestedChart})	this method returns the URIs with default values for all the charts
GET associations({associationId})/charts	this method returns the URIs with default values for all the charts

EventAttendee

API	Description
POST associations({associationId})/events({eventId})/attendees	Method to create an event attendee
GET associations({associationId})/events/attendees	Method to get all attendees for all events
PUT associations({associationId})/events({eventId})/attendees({attendeeId})	Method to update an event attendee
POST associations({associationId})/events({eventId})/attendees({attendeeId})	Method to create an event attendee
DELETE associations({associationId})/events({eventId})/attendees({attendeeId})	Method to delete an event attendee

FeaturedEvents

API	Description
GET associations({associationId})/events/featured	Method to get featured events

EventSponsors

API	Description
GET associations({associationId})/events/sponsors	Gets all event sponsors in an association

StatusUpdate

API	Description
DELETE associations({associationId})/representatives/status({statusUpdateId})	Method to delete a status update
POST associations({associationId})/representatives/status({statusUpdateId})/photo	Method to post images to a status update
POST associations({associationId})/representatives/status/video	Method to post videos to a status update
POST associations({associationId})/representatives/status	Method to post a new status update
GET associations({associationId})/status({statusUpdateId})/likes	Method to get all likes for a status update
GET associations({associationId})/status/type	Method to get all status update types for an association
GET associations({associationId})/status	Method to get all status updates for an association

AssociationKeys

API	Description
GET associations({associationId})/ApiKeys({keyId})	No documentation available.
PUT associations({associationId})/ApiKeys({keyId})	No documentation available.
GET associations({associationId})/ApiKeys	No documentation available.

RecentActivity

API	Description
GET associations({associationId})/RecentActivity/Types	No documentation available.
GET associations({associationId})/RecentActivity	No documentation available.

StatusUpdateLike

API	Description
DELETE associations({associationId})/representatives({representativeId})/status({statusUpdateId})/likes	Method to delete a like on a status update
POST associations({associationId})/representatives({representativeId})/status({statusUpdateId})/likes	Method to post a like on a status update
GET associations({associationId})/representatives({representativeId})/status({statusUpdateId})/likes	Method to post a like on a status update

TaskList

API	Description
GET associations({associationId})/representatives({representativeId})/TaskList	Gets TaskList for a association

CorrespondenceCategory

API	Description
GET associations({associationId})/tasks	this method gets a list of all categories

Files

API	Description
POST associations({associationId})/files/types({fileTypeId})	No documentation available.
POST associations({associationId})/files({fileId})	No documentation available.

News

API	Description
POST associations({associationId})/news({itemId})/image	Method to post a image for a news item
PUT associations({associationId})/News({itemId})	Method to update a news release
GET associations({associationId})/News	this method gets a bunch of News Releases
POST associations({associationId})/News	Method to add a news release