Follow

Bundles API call

You can use the Bundles API call to retrieve information about a particular membership bundle. You can retrieve information for a specific bundle, or retrieve information for all bundles created using a particular membership level.

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

Retrieving information for a specific bundle

You can retrieve bundle information about a specific bundle by specifying the bundle ID. The bundle ID is returned by the Contacts API call, and by the Bundles API call when using it to retrieve bundle information for a particular membership level (see below).

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/Bundles/[bundleID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/Bundles/9086

Retrieving bundle information for a membership level

You can retrieve bundle information for all bundles created using a particular membership level by specifying the membership level ID.

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/Bundles/?levelId=[levelID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/Bundles/?levelId=29881

Parameters

The following parameters are used within the Bundles API call:

baseAPIaddress
The base address of the API. For more information, see API access options.

accountID
The account identifier that is returned by the Accounts API call.

bundleID
The unique identifier for a membership bundle. The bundle ID is returned by the Contacts API call, and by the Bundles API call when using it to retrieve bundle information for a particular membership level.

levelID
The unique identifier for a membership level. The membership level ID is returned by the MembershipLevels API call.

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Response fields

For each bundle, the Bundles API call retrieves the following information.

Administrator
The contact ID and contact URL of the bundle administrator.

Email
The email address of the bundle administrator.

ID
The bundle ID.

Members
The contact ID and contact URL of each member in the bundle. This field is only returned when the request is sent using a bundle ID.

MembershipLevel
The ID and URL of the membership level used to create the bundle.

ParticipantsCount
The number of members in the bundle.

SpaceLeft
The number of spaces left in the bundle.

URL
The address of the API request for the bundle.

Sample JSON response

 {
"Email": "jdixon@test.com",
"ParticipantsCount": 1,
"Administrator": {
"Id": 725186,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Contacts/725186"
},
"MembershipLevel": {
"Id": 29881,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29881"
},
"SpaceLeft": 24,
"Members": [
{
"Id": 725186,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Contacts/725186"
}
],
"Id": 9086,
"Url": "http://api.wildapricot.org/v2/accounts/42353/Bundles/9086"
}

Sample XML response

<Bundle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bonasource.MembershipFS.PublicAPI.Model.V2.Contacts">
<Id xmlns="http://api.wildapricot.org">9086</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/Bundles/9086</Url>
<Administrator xmlns:d2p1="http://api.wildapricot.org">
<d2p1:Id>725186</d2p1:Id>
<d2p1:Url>http://api.wildapricot.org/v2/accounts/42353/Contacts/725186</d2p1:Url>
</Administrator>
<Email>jdixon@test.com</Email>
<Members xmlns:d2p1="http://api.wildapricot.org">
<d2p1:LinkedResourceOfint>
<d2p1:Id>725186</d2p1:Id>
<d2p1:Url>http://api.wildapricot.org/v2/accounts/42353/Contacts/725186</d2p1:Url>
</d2p1:LinkedResourceOfint>
</Members>
<MembershipLevel xmlns:d2p1="http://api.wildapricot.org">
<d2p1:Id>29881</d2p1:Id>
<d2p1:Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29881</d2p1:Url>
</MembershipLevel>
<ParticipantsCount>1</ParticipantsCount>
<SpaceLeft>24</SpaceLeft>
</Bundle>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.