Purpose
Groups indicate an association with a department, board, or committee. Each
meeting MUST be associated with a group.
List Meeting Groups
API Path - Public: api/v1/public/meeting-group/list.json
API Path - Authenticated: api/v1/authenticated/meeting-group/list.json
Request Type: GET
Description:
List Meeting Groups
| Field | Type | Description |
|---|
| Parameters |
| NONE | | |
| Sample Type | Data |
|---|
| Code - Authenticated Request |
$url = 'https://sandbox1.teamaha.com/' . 'api/v1/authenticated/meeting-group/list.json';
$options['headers'] = array(
'Content-Type:application/json',
'Authorization: Basic '. base64_encode("username:password"),
);
$options['query'] = array();
$query = '';
if (!empty($options['query'])) {
$query = '?' . http_build_query($options['query']);
}
$curl = curl_init();
$curlopts = array(
CURLOPT_URL => $url . $query,
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_USERAGENT => 'APITEST',
CURLOPT_HTTPHEADER => $options['headers'],
);
curl_setopt_array($curl,$curlopts);
$result = curl_exec($curl);
curl_close($curl);
print $result;
|
| Response |
{
"Groups": [
{
"GroupID": "27",
"GroupName": "City Council",
"GroupSynonym": "citycouncil"
},
{
"GroupID": "22",
"GroupName": "Human Resources",
"GroupSynonym": "hr"
}
],
"errors": []
}
|
Meeting Group Details
API Path - Public: api/v1/public/meeting-group/1234/details.json
API Path - Authenticated: api/v1/authenticated/meeting-group/1234/details.json
Request Type: GET
Description:
Meeting Group Details
| Field | Type | Description |
|---|
| Parameters |
| NONE | | |
| Sample Type | Data |
|---|
| Request |
$url = 'https://sandbox1.teamaha.com/' . 'api/v1/authenticated/meeting-group/27,hr/details.json';
$options['headers'] = array(
'Content-Type:application/json',
'Authorization: Basic '. base64_encode("username:password"),
);
$options['query'] = array();
$query = '';
if (!empty($options['query'])) {
$query = '?' . http_build_query($options['query']);
}
$curl = curl_init();
$curlopts = array(
CURLOPT_URL => $url . $query,
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_USERAGENT => 'APITEST',
CURLOPT_HTTPHEADER => $options['headers'],
);
curl_setopt_array($curl,$curlopts);
$result = curl_exec($curl);
curl_close($curl);
print $result;
|
| Response |
{
"Groups": [
{
"GroupID": "27",
"GroupName": "City Council",
"GroupSynonym": "citycouncil"
},
{
"GroupID": "22",
"GroupName": "Human Resources",
"GroupSynonym": "hr"
}
],
"errors": []
}
|
