Skip to content

Latest commit

 

History

History
621 lines (464 loc) · 24 KB

CommunityGroupApi.md

File metadata and controls

621 lines (464 loc) · 24 KB

Membercare\Client\CommunityGroupApi

All URIs are relative to /

Method HTTP request Description
getCommunityFileChanges GET /api/v1/communityGroups/Changes/Files Get a paged result of community files changes for all groups.
getCommunityFileChangesByGroup GET /api/v1/communityGroups/{groupId}/Changes/Files Get a paged result of community file changes for the chosen group.
getCommunityGroup GET /api/v1/communityGroups/{groupId} Get a community group with origin
getCommunityGroupAnnouncementChanges GET /api/v1/communityGroups/Changes/Announcements Get a paged result of community group announcement changes for all groups.
getCommunityGroupAnnouncementChangesByGroup GET /api/v1/communityGroups/{groupId}/Changes/Announcements Get a paged result of community group announcement changes for the chosen group.
getCommunityGroupMeetingChanges GET /api/v1/communityGroups/Changes/Meetings Get a paged result of community group meeting changes for all groups.
getCommunityGroupMeetingChangesByGroup GET /api/v1/communityGroups/{groupId}/Changes/Meetings Get a paged result of community group meeting changes for the chosen group.
getCommunityGroupMembers GET /api/v1/communityGroups/{groupId}/Members Get members of a community group
getCommunityGroupMessageChanges GET /api/v1/communityGroups/Changes/Messages Get a paged result of community group message changes for all groups.
getCommunityGroupMessageChangesByGroup GET /api/v1/communityGroups/{groupId}/Changes/Messages Get a paged result of community group message changes for the chosen group.
getCommunityGroups GET /api/v1/communityGroups Get a paged result of community groups with origin

getCommunityFileChanges

\Membercare\Client\Model\CommunityFileChangeInfoPagedResult getCommunityFileChanges($token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community files changes for all groups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityFileChanges($token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityFileChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityFileChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityFileChangesByGroup

\Membercare\Client\Model\CommunityFileChangeInfoPagedResult getCommunityFileChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community file changes for the chosen group.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityFileChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityFileChangesByGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityFileChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroup

\Membercare\Client\Model\CommunityGroupWithOrigin getCommunityGroup($group_id, $token)

Get a community group with origin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token

try {
    $result = $apiInstance->getCommunityGroup($group_id, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token

Return type

\Membercare\Client\Model\CommunityGroupWithOrigin

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupAnnouncementChanges

\Membercare\Client\Model\CommunityGroupAnnouncementChangeInfoPagedResult getCommunityGroupAnnouncementChanges($token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group announcement changes for all groups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupAnnouncementChanges($token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupAnnouncementChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupAnnouncementChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupAnnouncementChangesByGroup

\Membercare\Client\Model\CommunityGroupAnnouncementChangeInfoPagedResult getCommunityGroupAnnouncementChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group announcement changes for the chosen group.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupAnnouncementChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupAnnouncementChangesByGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupAnnouncementChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupMeetingChanges

\Membercare\Client\Model\CommunityGroupMeetingChangeInfoPagedResult getCommunityGroupMeetingChanges($token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group meeting changes for all groups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupMeetingChanges($token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupMeetingChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupMeetingChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupMeetingChangesByGroup

\Membercare\Client\Model\CommunityGroupMeetingChangeInfoPagedResult getCommunityGroupMeetingChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group meeting changes for the chosen group.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupMeetingChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupMeetingChangesByGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupMeetingChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupMembers

\Membercare\Client\Model\CommunityGroupMemberPagedResult getCommunityGroupMembers($group_id, $token, $page, $page_size)

Get members of a community group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupMembers($group_id, $token, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupMembers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupMemberPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupMessageChanges

\Membercare\Client\Model\CommunityGroupMessageChangeInfoPagedResult getCommunityGroupMessageChanges($token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group message changes for all groups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupMessageChanges($token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupMessageChanges: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupMessageChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroupMessageChangesByGroup

\Membercare\Client\Model\CommunityGroupMessageChangeInfoPagedResult getCommunityGroupMessageChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size)

Get a paged result of community group message changes for the chosen group.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$group_id = 789; // int | 
$token = "token_example"; // string | access token
$changed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$changed_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | If not set current time will be used
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroupMessageChangesByGroup($group_id, $token, $changed_after, $changed_before, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroupMessageChangesByGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id int
token string access token
changed_after \DateTime [optional]
changed_before \DateTime If not set current time will be used [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupMessageChangeInfoPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunityGroups

\Membercare\Client\Model\CommunityGroupWithOriginPagedResult getCommunityGroups($token, $valid_on, $page, $page_size)

Get a paged result of community groups with origin

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Membercare\Client\Api\CommunityGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token = "token_example"; // string | access token
$valid_on = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCommunityGroups($token, $valid_on, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityGroupApi->getCommunityGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
valid_on \DateTime [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CommunityGroupWithOriginPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]