Loading ...

REST API: Get Upcoming Birthdays and Work Anniversaries | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Upcoming Birthdays and Work Anniversaries
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Get Upcoming Birthdays and Work Anniversaries

0 
 /5
0 (0votes)

Get Upcoming Birthdays and Work Anniversaries

GET /api/users/celebrations

Get a list of users with upcoming birthdays and work anniversaries. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
OnlyBirthdays

&OnlyBirthdays=x - Used in the request URL as a query parameter

 Get only birthdays if set to true.
SpaceID

&SpaceID=x - Used in the request URL as a query parameter

 Space ID of the space from where we will fetch the users, and will display birthdays of those users.
NumberOfDays

&NumberOfDays=x - Used in the request URL as a query parameter

 Number of days from today to fetch upcoming birthdays. (Default=30)

Example Request 

GET https://myintranet.communifire.com/api/users/celebrations

Example Response

Users JSON object is returned as ResponseData.

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/549/3b01f586-c0a9-4bd7-9529-8079f43f6678.png",
            "AvatarPath": "549/3b01f586-c0a9-4bd7-9529-8079f43f6678.png",
            "BlogID": 0,
            "DOB": "1985-03-30T00:00:00",
            "DateFormat": "M/d/yyyy",
            "DateJoined": "2017-10-31T05:43:19.347",
            "DateLastVisited": "2017-10-31T05:43:19.347",
            "Email": "user1265@axerosolutions.com",
            "EmailRecieve": 3,
            "SpaceDigestOption": 1,
            "FirstName": "Judy",
            "Gender": 0,
            "IP": "",
            "InvitationID": 0,
            "IsActivated": true,
            "IsAnonymous": false,
            "IsUserLocked": false,
            "IsBanned": false,
            "IsConfirmed": false,
            "IsContactInfoVisible": true,
            "IsFeatured": false,
            "IsIsolated": false,
            "IsProfileCompleted": false,
            "IsOptInPromotionalEmails": false,
            "IsPasswordEncrypted": true,
            "IsProfilePublic": true,
            "LastName": "Jones",
            "MediaServerID": 0,
            "MembershipStatus": 0,
            "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
            "MetaKeywords": "user1265, ",
            "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
            "NumBlogPosts": 0,
            "NumPosts": 0,
            "Occupation": "Financial Analyst",
            "PMNotification": false,
            "Points": 0,
            "ProfilePhoto": "549/6f5d818a-dd4a-4e38-b4a4-9c74e90b1112.png",
            "ProfileURL": "https://myintranet.communifire.com/people/user1265",
            "OnlineChatStatus": 1,
            "RankID": 1,
            "RankImage": "rank-lurker.gif",
            "RankName": "Lurker",
            "RoleID": 0,
            "ShowEmail": true,
            "TimeFormat": "h:mm tt",
            "TimeZoneID": "US Mountain Standard Time",
            "UserID": 549,
            "UserInfoDisplayName": "Judy Jones",
            "UserName": "user1265",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "LastChatActivityDate": "0001-01-01T00:00:00",
            "UserPresenceStatus": 3,
            "IsBirthday": true,
            "Years": 34,
            "YearsString": "34 years served",
            "NextAnniversary": "2019-03-30T00:00:00",
            "NextAnniversaryString": "3/30",
            "IsPasswordHashed": false,
            "InOrgChart": false,
            "ConnectionStatus": 0,
            "CanChat": false,
            "TenantID": 0
        },
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/613/6e0659eb-4eb8-47f6-950f-4a146dc0b73c.png",
            "AvatarPath": "613/6e0659eb-4eb8-47f6-950f-4a146dc0b73c.png",
            "BlogID": 0,
            "DOB": "1977-04-10T00:00:00",
            "DateFormat": "M/d/yyyy",
            "DateJoined": "2017-10-31T05:45:09.927",
            "DateLastVisited": "2017-10-31T05:45:09.927",
            "Email": "user1329@axerosolutions.com",
            "EmailRecieve": 3,
            "SpaceDigestOption": 1,
            "FirstName": "Leisa",
            "Gender": 0,
            "IP": "",
            "InvitationID": 0,
            "IsActivated": true,
            "IsAnonymous": false,
            "IsUserLocked": false,
            "IsBanned": false,
            "IsConfirmed": false,
            "IsContactInfoVisible": true,
            "IsFeatured": false,
            "IsIsolated": false,
            "IsProfileCompleted": false,
            "IsOptInPromotionalEmails": false,
            "IsPasswordEncrypted": true,
            "IsProfilePublic": true,
            "LastName": "Black",
            "MediaServerID": 0,
            "MembershipStatus": 0,
            "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
            "MetaKeywords": "user1329, ",
            "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
            "NumBlogPosts": 0,
            "NumPosts": 0,
            "Occupation": "Sales Representative",
            "PMNotification": false,
            "Points": 0,
            "ProfilePhoto": "613/1116832c-706c-4af5-b057-39a347b13386.png",
            "ProfileURL": "https://myintranet.communifire.com/people/user1329",
            "OnlineChatStatus": 1,
            "RankID": 1,
            "RankImage": "rank-lurker.gif",
            "RankName": "Lurker",
            "RoleID": 0,
            "ShowEmail": true,
            "TimeFormat": "h:mm tt",
            "TimeZoneID": "US Mountain Standard Time",
            "UserID": 613,
            "UserInfoDisplayName": "Leisa Black",
            "UserName": "user1329",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "LastChatActivityDate": "0001-01-01T00:00:00",
            "UserPresenceStatus": 3,
            "IsBirthday": true,
            "Years": 42,
            "YearsString": "42 years served",
            "NextAnniversary": "2019-04-10T00:00:00",
            "NextAnniversaryString": "4/10",
            "IsPasswordHashed": false,
            "InOrgChart": false,
            "ConnectionStatus": 0,
            "CanChat": false,
            "TenantID": 0
        }
    ]
}

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software