API

WebsiteAPI V1

API Details

Description: For use with Authenticated web users - Use the Authentication API to obtain a token
HMAC: None

API Resources

Below is a list of resources available on this API and if they allow the four verbs, this is shown by a list with "Get Post Put Del" representing all "- - - -" respresenting none

Name Description Filter Sort Allows
CommunicationPrivate API resource which allows access to view, edit and insert communications in Access Charity CRM. Get Post Put -
CommunicationPublic API resource which allows to insert communications in Access Charity CRM. - Post - -
ContactExtraAddressesPrivate API resource which allows access to view addresses in Access Charity CRM. Get - - -
ContactParameterPrivate API resource which allows access to view, edit and insert extra parameters related to a contact in Access Charity CRM. PARAMETERID Get Post Put -
ContactParameterPublic API resource which allows to insert extra parameters related to a contact in Access Charity CRM. PARAMETERID - Post - -
ContactPrivate API resource which allows access to view and edit contacts in Access Charity CRM. Get - Put -
ContactPublic API resource which allows to insert contacts in Access Charity CRM. - Post - -
DestinationCodePublic API resource which allows access to view destination codes in Access Charity CRM. PublishToWeb = -1 DestinationCode Get - - -
DonationPrivate API resource which allows access to view and insert payments in Access Charity CRM. Get Post - -
DonationPublic API resource which allows access to insert payments in Access Charity CRM. - Post - -
EnvelopeSalutationPublic API resource which allows payment of the next instalment of a membership. - Post - -
EventAttendeePrivate API resource to return details of attendee records where the attendee is the logged in user Get - - -
EventAttendeeTypePublic API resource which allows access to view attendee types for an event. Get - - -
EventBookerAttendeePrivate API resource to return details of attendees for a logged in users bookings Get - - -
EventBookingDetailPrivate API resource which allows access to edit and insert event booking details in Access Charity CRM. Get Post - -
EventBookingDetailPublic API resource which allows access to insert event booking details in Access Charity CRM. - Post - -
EventBookingInVerificationPrivate API resource which allows access to view, edit and insert event bookings in Access Charity CRM. Get Post Put -
EventBookingInVerificationPublic API resource which allows access to insert event bookings in Access Charity CRM. - Post - -
EventBookingPrivate API resource which allows access to view and edit event bookings for an event. Get - Put -
EventPayPrivate API resource to pay an event booking. - Post - -
EventPayPublic API resource to pay an event booking. - Post - -
EventPublic API resource which allows access to view events in Access Charity CRM. Get - - -
EventStructureAttendeesPublic Resource allowing users to post structures when logged in - Post - -
EventStructurePublic API resource which allows access to view event structures in Access Charity CRM. Get - - -
FinancialsContactLinkPublic API resource which allows to view any mappings between a contact in Access Charity CRM and Financials. This will return the customer/supplier code from Financials and the Serial Number from Access Charity CRM. Provider = 'Dimensions' SERIALNUMBER Get - - -
GiftAidDeclarationPrivate API resource which allows access to view, edit and insert gift aid declarations in Access Charity CRM. Get Post Put -
GiftAidDeclarationPublic API resource which allows access to insert gift aid declarations in Access Charity CRM. - Post - -
GroupDetailPrivate API resource which allows access to view, edit and insert details of a group. Get Post Put Del
GroupDetailPublic API resource which allows to edit details of a group. - Post - -
GroupHeaderPublic API resource which allows access to view a group. PublishToWeb = -1 Get - - -
LookupvaluePublic API resource which allows access to view look up values from Access Charity CRM. Get - - -
MailingPurposeAdminPublic API resource which allows access to view mailing purposes from Access Charity CRM. CATEGORY ASC, PURPOSE ASC Get - - -
MailingPurposeConsentPrivate Private API resource which allows a user to view and add purpose consents while the contact is in the Access Charity CRM system (after verification) Get Post - -
MailingPurposeInVerificationPrivate Private API resource which allows a user to view, add and update purposes while the contact is in verification SERIALNUMBER ASC, PURPOSE ASC Get Post - -
MailingPurposeInVerificationPublic Public API resource which allows a user to add purposes while the contact is in verification SERIALNUMBER ASC, PURPOSE ASC - Post - -
MembershipAdminBandPublic API resource which allows access to view membership bands. Get - - -
MembershipAdminCriteriaFeePublic API resource which allows access to view membership criteria fees. Get - - -
MembershipAdminDiscPublic API resource which allows access to view membership discounts. Get - - -
MembershipAdminOptionalBenefitPublic API resource which allows access to view membership optional benifits. Get - - -
MembershipAdminSchemePublic API resource which allows access to view membership schemes. Get - - -
MembershipAdminWebPaymentTypePublic API resource which allows access to view payments types for a membership. Get - - -
MembershipDetailCriteriaFeePrivate API resource which allows access to view and post criteria fees against a specific membership. Get Post - -
MembershipDetailCriteriaFeePublic API resource which allows access to post criteria fees against a specific membership. - Post - -
MembershipDetailOptionalBenefitPrivate API resource which allows access to view and post optional benifits against a specific membership. Get Post - -
MembershipDetailOptionalBenefitPublic API resource which allows access to post optional benifits against a specific membership. - Post - -
MembershipDiscountHistoryPrivate API resource which allows access to view discount history for a specific membership. Get - - -
MembershipFinishNewMembershipPrivate API resource which will be used after creating a new membership to finish the process. Allows inserts. - Post - -
MembershipFinishNewMembershipPublic API resource which will be used after creating a new membership to finish the process. Allows inserts. - Post - -
MembershipHeaderPrivate API resource which allows access to view and post new memberships. Get Post - -
MembershipHeaderPublic API resource which allows access to post new memberships. - Post - -
MembershipPayPrivate API resource which allows payment of the next instalment of a membership. - Post - -
MembershipPayPublic API resource which allows payment of the next instalment of a membership. - Post - -
NewWebUserPublic API resource which allows access to insert web users into Access Charity CRM. - Post - -
PaymentPrivate API resource which allows access to view payments in Access Charity CRM. INCOMETYPE <> 'HEADER' Get - - -
PersonnelSkillPrivate API resource which allows access to view, edit and insert personnel skills into Access Charity CRM. Get Post Put -
PersonnelSkillPublic API resource which allows access to insert personnel skills into Access Charity CRM. - Post - -
PledgeDestinationPrivate This API shows the destination codes against a pledge. It also allows insertion of destination codes against a new pledge Get Post - -
PledgeDestinationPublic This API shows the destination codes against a pledge. It also allows insertion of destination codes against a new pledge. Allows Inserts - Post - -
PledgeInstalmentPrivate This call shows the instalments for verified pledges in Access Charity CRM INVERIFICATION=0 DATEDUE Get - - -
PledgeInVerificationPrivate This API call allows a a user to see pledges in Access Charity CRM which are in verification. It also allows a user to post new pledges. Get Post - -
PledgeInVerificationPublic This API call allow the user to post new pledges. STARTDATE DESC, PLEDGEID DESC - Post - -
PledgeVerifiedPrivate This API call allows a a user to see pledges in Access Charity CRM which are not in verification PLEDGEHEADER.INCOMETYPE='DONATION' STARTDATE DESC Get - - -
SalesOrderDetailPrivate Resource which can be used to view, post and update order detail lines in Access Charity CRM for logged in users Get Post Put -
SalesOrderDetailPublic Resource which can be used to post order detail lines in Access Charity CRM for logged out users - Post - -
SalesOrderHeaderPrivate Resource which can be used to veiw, post and update orders in Access Charity CRM for logged in users Get Post Put -
SalesOrderHeaderPublic Resource which can be used to post orders in Access Charity CRM for logged out users - Post - -
SalesOrderProductPublic Resource which can be used to view, post and update products in Access Charity CRM Get Post Put -
SourceCodePublic API resource which allows access to view source codes in Access Charity CRM. PublishToWeb = -1 Sourcecode Get - - -
UpdatePasswordPrivate API resource which allows access to view and edit web user's password in Access Charity CRM. Get - Put -
UpdatePasswordPublic This API call allows a new password to be posted along with the username - Post - -