Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getTeamraiserConfigResponse xmlns="http://convio.com/crm/v1.0">
    <teamraiserConfig>
        <acceptingRegistrations>true</acceptingRegistrations>
        <acceptingDonations>true</acceptingDonations>
        <companyAssociationAllowed>true</companyAssociationAllowed>
        <companyNewEntryAllowed>false</companyNewEntryAllowed>
        <participantCompanyAssociationAllowed>true</participantCompanyAssociationAllowed>
        <participantCompanyNewEntryAllowed>false</participantCompanyNewEntryAllowed>
        <familyRegistrationAllowed>true</familyRegistrationAllowed>
        <offlineGiftTypes>
            <cash>true</cash>
            <check>true</check>
            <credit>false</credit>
            <later>false</later>
        </offlineGiftTypes>
        <offlineTeamGifts>MEMBERS</offlineTeamGifts>
        <indicateUnconfirmed>false</indicateUnconfirmed>
        <personalBlogAllowed>false</personalBlogAllowed>
        <personalGoalAllowed>true</personalGoalAllowed>
        <personalOfflineGiftsAllowed>true</personalOfflineGiftsAllowed>
        <personalPageApprovalRequired>false</personalPageApprovalRequired>
        <personalPageEditing>PARTICIPANTS</personalPageEditing>
        <personalPageSecondPhoto>false</personalPageSecondPhoto>
        <personalPageLayoutAllowed>false</personalPageLayoutAllowed>
        <personalPageStyleAllowed>false</personalPageStyleAllowed>
        <personalPageStatusAllowed>false</personalPageStatusAllowed>
        <personalSurveyEditAllowed>false</personalSurveyEditAllowed>
        <showGiftCategories>false</showGiftCategories>
        <teamCaptainsMaximum>2</teamCaptainsMaximum>
        <teamSizeMaximum>15</teamSizeMaximum>
        <fbConnectPublishFeedImageUrl>http://www.example.com</fbConnectPublishFeedImageUrl>
        <fbConnectPublishFeedImageSrc>http://www.example.com/image.gif</fbConnectPublishFeedImageSrc>
        <ociEnabled>true</ociEnabled>
        <ociBaseUrl>http://www.example.com/oci_base</ociBaseUrl>
        <recruitingGoalsEnabled>false</recruitingGoalsEnabled>
        <teamsAllowed>true</teamsAllowed>
        <teamDivisionsEnabled>false</teamDivisionsEnabled>
        <teamPasswordAllowed>false</teamPasswordAllowed>
        <eventManageUrl xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <companyManageUrl xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <personalDonationsDownloadUrl xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <categoryId>1</categoryId>
        <pagingMaxPageSize>500</pagingMaxPageSize>
        <defaultStationeryId>1001</defaultStationeryId>
        <teamGiftsAllowed>false</teamGiftsAllowed>
        <emailStatisticsEnabled>false</emailStatisticsEnabled>
        <adminNewsFeedsEnabled>false</adminNewsFeedsEnabled>
        <standardRegistrationAllowed>true</standardRegistrationAllowed>
        <anonymousRegistrationAllowed>false</anonymousRegistrationAllowed>
        <screennameRegistrationAllowed>false</screennameRegistrationAllowed>
        <affiliateTypeId>1</affiliateTypeId>
        <leadFrId>1000</leadFrId>
        <eCommerceStoreId>1001</eCommerceStoreId>
        <eCommerceStoreName>Teamraiser Store</eCommerceStoreName>
        <eCommerceProductId>1005</eCommerceProductId>
        <eCommerceProductName>Teamraiser Product</eCommerceProductName>
        <redirectURL xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <systemRedirectURL xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <customizedURL>http://www.example.com/customizedtUrl</customizedURL>
        <additionalDonationAllowed>true</additionalDonationAllowed>
        <donationLevels>
            <manualAllowed>true</manualAllowed>
            <donationLevel>
                <order>1</order>
                <name>Gold</name>
                <amount>
                    <decimal>50.0</decimal>
                    <formatted>$50.00</formatted>
                </amount>
                <description>Gold donation level.</description>
            </donationLevel>
            <donationLevel>
                <order>2</order>
                <name>Silver</name>
                <amount>
                    <decimal>25.0</decimal>
                    <formatted>$25.00</formatted>
                </amount>
                <description>Silver Donation Level</description>
            </donationLevel>
        </donationLevels>
        <singleLocaleEvent>false</singleLocaleEvent>
        <facebookFundraisingEnabled>false</facebookFundraisingEnabled>
        <facebookAppId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <facebookDefaultTitle xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <facebookDefaultDescription xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <facebookFundraiserEndDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <facebookFundraiserEndDateByDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <usePersonalPageContentForFacebookFundraisers xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </teamraiserConfig>
</getTeamraiserConfigResponse>


        

{"getTeamraiserConfigResponse":{"teamraiserConfig":{"participantCompanyNewEntryAllowed":"false","facebookAppId":null,"companyManageUrl":null,"teamGiftsAllowed":"false","redirectURL":null,"facebookFundraiserEndDateByDays":null,"ociBaseUrl":"http://www.example.com/oci_base","facebookFundraisingEnabled":"false","teamPasswordAllowed":"false","affiliateTypeId":"1","personalPageEditing":"PARTICIPANTS","anonymousRegistrationAllowed":"false","eCommerceStoreName":"Teamraiser Store","personalPageStatusAllowed":"false","ociEnabled":"true","personalPageSecondPhoto":"false","teamsAllowed":"true","personalSurveyEditAllowed":"false","companyAssociationAllowed":"true","personalBlogAllowed":"false","eCommerceProductName":"Teamraiser Product","personalPageLayoutAllowed":"false","facebookDefaultTitle":null,"acceptingDonations":"true","recruitingGoalsEnabled":"false","adminNewsFeedsEnabled":"false","emailStatisticsEnabled":"false","teamSizeMaximum":"15","showGiftCategories":"false","systemRedirectURL":null,"familyRegistrationAllowed":"true","indicateUnconfirmed":"false","fbConnectPublishFeedImageUrl":"http://www.example.com","offlineGiftTypes":{"later":"false","check":"true","credit":"false","cash":"true"},"offlineTeamGifts":"MEMBERS","personalPageStyleAllowed":"false","personalDonationsDownloadUrl":null,"personalGoalAllowed":"true","defaultStationeryId":"1001","fbConnectPublishFeedImageSrc":"http://www.example.com/image.gif","facebookDefaultDescription":null,"teamCaptainsMaximum":"2","teamDivisionsEnabled":"false","screennameRegistrationAllowed":"false","additionalDonationAllowed":"true","personalOfflineGiftsAllowed":"true","companyNewEntryAllowed":"false","pagingMaxPageSize":"500","customizedURL":"http://www.example.com/customizedtUrl","standardRegistrationAllowed":"true","eCommerceStoreId":"1001","eventManageUrl":null,"donationLevels":{"manualAllowed":"true","donationLevel":[{"amount":{"formatted":"$50.00","decimal":"50.0"},"name":"Gold","description":"Gold donation level.","order":"1"},{"amount":{"formatted":"$25.00","decimal":"25.0"},"name":"Silver","description":"Silver Donation Level","order":"2"}]},"usePersonalPageContentForFacebookFundraisers":null,"personalPageApprovalRequired":"false","facebookFundraiserEndDate":null,"participantCompanyAssociationAllowed":"true","acceptingRegistrations":"true","eCommerceProductId":"1005","categoryId":"1","leadFrId":"1000","singleLocaleEvent":"false"}}}