Get Connection

Get connection status, i.e. check if the calling user is connected to the specified user.

The status of the connection invitation to another user.

get

Path parameters

userIdstringRequired

user Id

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

OK

application/json

Connection status between two users

userIdinteger · int64Optional

user id

Example: 769658112378

statusstring · enumOptional

Connection status between the requesting user and the request sender

Example: ACCEPTEDPossible values:

firstRequestedAtinteger · int64Optional

unix timestamp when the first request was made

Example: 1470018073812

updatedAtinteger · int64Optional

unix timestamp on the last updated date

Example: 1471018076255

requestCounterinteger · int32Optional

number of requests made

Example: 1

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not Found: Connection cannot be found.

application/json

500

Server error, see response body for further details.

application/json

get

/v1/connection/user/{userId}/info

HTTPcURLJavaScriptPython

GET /pod/v1/connection/user/{userId}/info HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "userId": 769658112378,
  "status": "ACCEPTED",
  "firstRequestedAt": 1470018073812,
  "updatedAt": 1471018076255,
  "requestCounter": 1
}

📘 Note

• When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

• Pods from all users involved need to have crossPod enabled between them.

📘 404 Not Found

A 404 Not Found error indicates either:

• The specified user doesn’t exist.

• The calling user and specified user are not connected because a Create Connection request has not yet been sent.

📘 Internal Connections

Users who belong to the same private pod are implicitly connected. Getting the connection status with an internal user will return the corresponding connection object with a status of ACCEPTED.

Connection Status

Currently, there are four possible connection status:

• PENDING_INCOMING: The specified user requested to connect with the calling user.

• PENDING_OUTGOING: The calling user requested to connect with the specified user.

• ACCEPTED: The two users are connected.

• REJECTED: The two users are not connected.