Filter Announcements API

To filter announcements.

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request Parameters:

isSticky:if true is given then all the sticky announcements are filtered; if false is given then all announcements are filtered
location:Announcements of the location mentioned is filtered; if param not given then all location announcements are filtered ( if isSticky is given then this param will fetch based on results from isSticky)
enable:
  • if 1 is given and isSticky is true and Locations is given - then all enabled sticky announcements of the given location will be filtered
  • if 0 is given and isSticky is true and Location is given then all disabled sticky announcements of the given location will be filtered
  • if 1 is given and isSticky is true and no location is given then all enabled sticky announcements of all locations will be filtered
  • if 0 is given and isSticky is true and no location is given then all disabled sticky announcements of all locations will be filtered 
  • If 1 is given and isSticky is false/not given and Location is given, then all enabled announcements of the given locations will be filtered
  • if 0 is given and isSticky is false/not given and Location is given, then all disabled announcements of the given locations will be filtered
*startIdxthe starting index to be given - 10 records from the given starting index will be filtered at a time; starting index should be 1 or greater than 1 ( it will filter based on results from isSticky, location and enable params)

 Threshold Limit:  20 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Sample Request

Copiedhttps://people.zoho.com/people/api/announcement/getAnnouncementByID?id=3610330000098011

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

XMLJson
Copied<response uri="/api/announcement/getAnnouncementByID">
    <status>0</status>
    <message>Success</message>
    <result>
        <resultData>
            <announcementList>
                <data>
                    <owner>3000000013255</owner>
                    <modifiedTime>1542962837811</modifiedTime>
                    <subject>Wellness Program!</subject>
                    <isNotify>1</isNotify>
                    <isCommentDisable>1</isCommentDisable>
                    <announcementId>3000000166005</announcementId>
                    <publishDate>1542962837811</publishDate>
                    <expireDate>-1</expireDate>
                    <message>Enjoy a week-long wellness program at all our office locations.</message>
                    <isActive>true</isActive>
                    <isSticky>1</isSticky>
                    <notifyOthersEmailIds>c.spalding@zylker.com,</notifyOthersEmailIds>
                </data>
            </announcementList>
            <annLikeCnt>{}</annLikeCnt>
            <commentsCnt>{}</commentsCnt>
        </resultData>
    </result>
</response>
Copied{
    "response": {
        "result": {
            "resultData": {
                "announcementList": [
                    {
                        "owner": "3000000013255",
                        "modifiedTime": "1542962837811",
                        "subject": "Wellness Program!",
                        "isNotify": 1,                 
                        "isCommentDisable": 1,                        
                        "announcementId": "3000000166005",
                        "publishDate": "1542962837811",
                        "expireDate": -1,
                        "message": "Enjoy a week-long wellness program at all our office locations.",
                        "isActive": true,
                        "isSticky": 1,
                        "notifyOthersEmailIds": "c.spalding@zylker.com,"
                    }
                ],
                "annLikeCnt": {},
                "commentsCnt": {}
            }
        },
        "message": "Success",
        "uri": "/api/announcement/getAnnouncementByID", 
        "status": 0
    }
}