Authentication

API Path: api/v1/authenticated/*
Request Type: GET,POST,PATCH
Description:
HTTP Basic Authentication
Additional Information:
API implementations requiring authentication should require HTTPS. HTTP basic authentication, when used without HTTPS, will result in the password being sent unencrypted.

HTTP basic authentication requires the Authorization header to be included with each request. See this article for additional info.

Field	Type	Description
Parameters
data	JSON	The meeting agenda items to be created.

Sample Type	Data
Code - Authenticated Request	$url = 'https://sandbox1.teamaha.com/' . 'api/v1/authenticated/meeting/list.json'; $options['headers'] = array( 'Content-Type:application/json', 'Authorization: Basic '. base64_encode("username:password"), ); $options['query'] = array('unpublished' => 'include'); $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	{ "Meetings": [ { "MeetingID": "211", "RevisionID": "28691", "Title": "Future event", "Created": "2015-11-15 14:18:39", "Changed": "2017-08-13 19:11:02", "Visibility": "published", "GroupID": "27", "GroupName": "City Council", "GroupSynonym": "citycouncil", "Body": " Test<\/p>\r\n", "BodySummary": "", "RedirectToURL": null, "CalendarDate": [ { "Delta": "0", "FromDate": "2016-12-31 19:15:00", "ToDate": "2016-12-31 19:15:00", "TimeZone": "UTC", "#HIDDEN": null } ] }, { "MeetingID": "17361", "RevisionID": "29741", "Title": "Test Meeting 59cc141a52ed6", "Created": "2017-08-25 14:39:59", "Changed": "2017-09-27 17:11:57", "Visibility": "published", "GroupID": "21", "GroupName": "Planning", "GroupSynonym": "planning", "Body": " Test<\/p>\r\n", "BodySummary": "", "RedirectToURL": null, "CalendarDate": [ { "Delta": "0", "FromDate": "2017-09-01 04:00:00", "ToDate": "2017-09-01 04:00:00", "TimeZone": "UTC", "#HIDDEN": null } ] } ], "errors": [] }

Sample Type

Data

Code - Authenticated Request

$url = 'https://sandbox1.teamaha.com/' . 'api/v1/authenticated/meeting/list.json';
$options['headers'] = array(
  'Content-Type:application/json',
  'Authorization: Basic '. base64_encode("username:password"),
);
$options['query'] = array('unpublished' => 'include');
$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

{
    "Meetings": [
        {
            "MeetingID": "211",
            "RevisionID": "28691",
            "Title": "Future event",
            "Created": "2015-11-15 14:18:39",
            "Changed": "2017-08-13 19:11:02",
            "Visibility": "published",
            "GroupID": "27",
            "GroupName": "City Council",
            "GroupSynonym": "citycouncil",
            "Body": "
Test<\/p>\r\n",
            "BodySummary": "",
            "RedirectToURL": null,
            "CalendarDate": [
                {
                    "Delta": "0",
                    "FromDate": "2016-12-31 19:15:00",
                    "ToDate": "2016-12-31 19:15:00",
                    "TimeZone": "UTC",
                    "#HIDDEN": null
                }
            ]
        },
        {
            "MeetingID": "17361",
            "RevisionID": "29741",
            "Title": "Test Meeting  59cc141a52ed6",
            "Created": "2017-08-25 14:39:59",
            "Changed": "2017-09-27 17:11:57",
            "Visibility": "published",
            "GroupID": "21",
            "GroupName": "Planning",
            "GroupSynonym": "planning",
            "Body": "

Test<\/p>\r\n",
            "BodySummary": "",
            "RedirectToURL": null,
            "CalendarDate": [
                {
                    "Delta": "0",
                    "FromDate": "2017-09-01 04:00:00",
                    "ToDate": "2017-09-01 04:00:00",
                    "TimeZone": "UTC",
                    "#HIDDEN": null
                }
            ]
        }
    ],
    "errors": []
}