BG API Request and Response

bg_api.md

Client Lookup Endpoint

This endpoint takes a first name, last name, or nickname (or any combination of those) and returns a list of matching clients. You should use this endpoint to allow users of your app to search for a client.

Example 1

HTTP Request:

GET api.breakingground.org/clients/lookup?firstName="John"&lastName="Doe"&nickname="Red Cat"

JSON Response:

[
  {
    "clientId": 2356,
    "firstName": "John",
    "lastName": "Doe",
    "nickname": "Red Cat"
   }
]

Example 2

HTTP Request:

GET api.breakingground.org/clients/lookup?firstName="John"

JSON Response:

[
  {
    "clientId": 2356,
    "firstName": "John",
    "lastName": "Doe",
    "nickname": "Red Cat"
  },
  {
    "clientId": 5268,
    "firstName": "John",
    "lastName": "Smith"
  },
  {
    "clientId": 3256,
    "firstName": "John",
    "lastName": "Hamilton",
    "nickname" "Johnny H"
  },
  ...
]

Client "Show" Endpoint

This endpoint takes a client ID and returns information about that client. You could use this endpoint to get updated information about a particular client when you already know the client's ID.

Example 1

HTTP Request:

GET api.breakingground.org/clients/2356

JSON Response:

[
  {
    "clientId": 2356,
    "firstName": "John",
    "lastName": "Doe",
    "nickname": "Red Cat"
   }
]