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.

GETyourpodURL.symphony.com/pod/v1/connection/user/{userId}/info

Path parameters

userId*string

user Id

Header parameters

Response

200400401403404500

OK

Body

application/json

userIdinteger (int64)

user id

statusenum

Connection status between the requesting user and the request sender

PENDING_INCOMINGPENDING_OUTGOINGACCEPTEDREJECTED

firstRequestedAtinteger (int64)

unix timestamp when the first request was made

updatedAtinteger (int64)

unix timestamp on the last updated date

requestCounterinteger (int32)

number of requests made

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/connection/user/{userId}/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.