From b9eb1329a6dbec7b75c21d8e0eb13134121db6bb Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Sat, 19 Mar 2016 02:05:33 -0700 Subject: Initial commit for the CCB API Client. The client currently supports the following APIs: * individual_profiles * individual_profile_from_id * individual_profile_from_login_password * individual_profile_from_micr * custom_field_labels --- src/main/java/com/p4square/ccbapi/CCBAPI.java | 42 +++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 src/main/java/com/p4square/ccbapi/CCBAPI.java (limited to 'src/main/java/com/p4square/ccbapi/CCBAPI.java') diff --git a/src/main/java/com/p4square/ccbapi/CCBAPI.java b/src/main/java/com/p4square/ccbapi/CCBAPI.java new file mode 100644 index 0000000..e54e20b --- /dev/null +++ b/src/main/java/com/p4square/ccbapi/CCBAPI.java @@ -0,0 +1,42 @@ +package com.p4square.ccbapi; + +import com.p4square.ccbapi.model.*; + +import java.io.Closeable; +import java.io.IOException; + +/** + * CCBAPI is a Java interface for using the Church Community Builder API. + */ +public interface CCBAPI extends Closeable { + /** + * Retrieve the set of custom (user-defined) fields and the associated labels. + * + * @return A GetCustomFieldLabelsResponse containing the fields. + * @throws IOException on failure. + */ + GetCustomFieldLabelsResponse getCustomFieldLabels() throws IOException; + + /** + * Retrieve one or more IndividualProfiles. + * + * If any of the following properties are set on the request, + * this method will return the matching individual, if one exists. + * + * + * + * If more than one property is included only the first, in the order listed above, will be used. + * If none of the options are included, all individuals will be returned. + * + * The appropriate CCB API will be selected based on the options used. + * + * @param request A GetIndividualProfilesRequest. + * @return A GetIndividualProfilesResponse object on success, including when no individuals match. + * @throws IOException on failure. + */ + GetIndividualProfilesResponse getIndividualProfiles(GetIndividualProfilesRequest request) throws IOException; +} -- cgit v1.2.3