REST API: Check Connection Status

Anonymous User

Published: 4/4/2019

Grace Kamau

Updated: 9/23/2020

0 (0votes)

Check Connection Status

Check the connection status between two users. Valid for Communifire version 6.0 and above.

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.
UserID	Used in the request URL as a path parameter	User ID of the user who is sending the request.
ConnectionUserID	Used in the request URL as a path parameter	User ID of your connection.

An enum integer value is returned as ResponseData.


{
  "IsError": false,
  "ResponseMessage": "You are connected.",
  "ResponseData": 1
}

Enum Value	Description
1	You are connected
2	Your request is pending for approval
3	You need to approve the request
4	You are not connected

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