BCA Culture Technical Assistance API Guide

The purpose of this API guide is to enable our partners to retrieve data from BCA Culture related to their partner account. This data includes information about persons registered and their related activities.

API Client Key and Secret

To facilitate API integration, BCA Culture assigns a unique API client key and secret to each partner. Partners will use this client key and secret to authenticate into our system and generate a unique access token. This access token allows them to retrieve additional data.

API Endpoints

Partners have access to three API endpoints:

1. Get Bearer Token

Partners will use their assigned client key and secret to generate a bearer token. This token grants access to retrieve data about persons associated with BCA Culture.

Endpoint:

POST https://api.ta.bcaculture.com/bearer

Request Body:

{
    "ClientKey": "",
    "ClientSecret": ""
}
    

Try It

Response:

{
    "Success": true/false,
    "Error": "",
    "Token": "",
    "ExpiresUtc": ""
}
    

2. Get Persons

Partners will call this API to retrieve a list of all persons registered via any BCA Culture-hosted website or app and the data collected for each person.

Endpoint:

GET https://api.ta.bcaculture.com/persons/?type=Applicant or Client

HTTP Header:

Authorization: Bearer Token

Try It

Response:

{
    "Success": true/false,
    "Error": "",
    "Data": [
        {
           "Type": "Applicant",
           "PersonID": "GUID",
           "CreateUtc": "",
           "UpdateUtc": "",
           "Fields": [
               {
                   "Name": "",
                   "Value": [""]
               }
           ]
        }
    ],
    "NextPageUrl": ""
}
    

There are two types of person registrations:

1. Applicant: An applicant is someone who has registered to apply for the Technical Assistance program but has not yet become a BCA Culture client. They have not been given access to participate in the technical assistance program.

2. Client: A client is an applicant who has been accepted into the technical assistance program and has registered, gaining access to the BCA Culture platform to participate in the program.

3. Get Person Activity

Partners will call this API to retrieve all activities related to a particular person, identified by a unique person ID. The GetPersons API response includes the assigned person ID.

Endpoint:

GET https://api.ta.bcaculture.com/activity/{PersonID}

HTTP Header:

Authorization: Bearer Token

Try It

Response:

{
    "Success": true/false,
    "Error": "",
    "Data": [
        {
           "DateUtc": "",    
           "Code": "",
           "Description": "",
           "Duration": "",
           "Before": "",
           "After": ""
        }
    ],
    "NextPageUrl": ""
}
    

4. Get Person Surveys

Partners will call this API to retrieve all surveys completed by a particular person, identified by a unique person ID.

Endpoint:

GET https://api.ta.bcaculture.com/surveys/{PersonID}

HTTP Header:

Authorization: Bearer Token

Try It

Response:

{
    "Success": true/false,
    "Error": "",
    "Data": [
		{
		  "CohortGroup": "2024 Summer Cohort",
		  "Module": "START HERE",
		  "SurveyTitle": "Initial MBEP Survey",
		  "CompletedUtc": "20240717T234831Z",
		  "Response": [
			{
			  "Question": "What are your goals for your business in the next 6-12 months? For a description of each goal, click the icon next to the goal.",
			  "Options": [
				"Access to Capital: Securing funding to grow or sustain my business operations.",
				"Expansion & Growth: Funding for scaling up operations such as hiring new staff, purchasing new equipment or real estate, expanding product lines, opening new locations and/or entering new markets.",
				"Digital Technology & Innovation: Investing in technology to enhance infrastructure, productivity, efficiency and competitiveness",
				"Marketing & Branding: Allocating funds for marketing campaigns to increase brand viability, customer acquisition and business growth.",
				"Training & Development: Investing in workforce training and development to improve skills and capabilities.",
				"Diversification: Funding for diversifying product offerings, customer base, or revenue streams to reduce risk.",
				"Training & Development: Investing in workforce training and development to improve skills and capabilities.",
				"Community Engagement & Social Impact: Supporting initiatives that benefit  the local community or your target market, fostering goodwill and loyalty.",
				"Sustainability: Investing in environmentally friendly practices or socially responsible initiatives to align with values and attract socially conscious customers.",
				"Other, please specify:"
			  ],
			  "Answers": [
				"Access to Capital",
				"Expansion & Growth",
				"Digital Technology & Innovation",
				"Marketing & Branding",
				"Training & Development",
				"Diversification",
				"Training & Development",
				"Community Engagement & Social Impact",
				"Sustainability",
				"Other, please specify\nOne of my current challenges is improving my credit score to a level that supports both my business and personal financial needs. By achieving a healthier credit score, I aim to reduce reliance on personal funds for business expenses and establish a solid foundation for securing future credit and funding opportunities."
			  ],
			  "IsNotApplicable": false
			}
		  ]
		}
    ]
}
    

Activity Codes

- Created
- Deleted
- Login
- Logout
- Call
- Support
- TUScore
- EXPScore
- EFXScore
- DNBScore
- ReadinessScore
- StepCompleted