Jump to

• Request
• Response
• Examples

Get participants

get

/rest/ofscCollaboration/v1/chats/{chatId}/participants

This operation retrieves the participants of an existing chat. A maximum of 100 participants are retrieved in a single call.

Request

Path Parameters

• chatId(required): integer
  The unique identifier of the chat in Oracle Field Service.

Query Parameters

• limit: integer
  Minimum Value: 0

  Maximum Value: 100

  The number of items to be retrieved.

  Default Value: 10
• offset: integer
  Minimum Value: 0

  Maximum Value: 10000

  The index from which the items are retrieved.

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : ParticipantList

Type: object

The list of participants of the chat.

Show Source

• items: array items
  An array of items containing the participant details.
• limit: integer(int32)
  The limit value specified in the request.
• links: array links
  The array of pagination items.
• offset: integer(int32)
  The offset value specified in the request.
• totalResults: integer(int32)
  The total number of participants retrieved.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of participants retrieved."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"The limit value specified in the request."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The offset value specified in the request."
        },
        "items":{
            "type":"array",
            "description":"An array of items containing the participant details.",
            "items":{
                "$ref":"#/definitions/Participant"
            }
        },
        "links":{
            "type":"array",
            "description":"The array of pagination items.",
            "items":{
                "$ref":"#/definitions/PaginationLink"
            }
        }
    },
    "description":"The list of participants of the chat."
}

Nested Schema : items

Type: array

An array of items containing the participant details.

Show Source

• Array of: object Participant
  The details of the participant.

{
    "type":"array",
    "description":"An array of items containing the participant details.",
    "items":{
        "$ref":"#/definitions/Participant"
    }
}

Nested Schema : links

Type: array

The array of pagination items.

Show Source

• Array of: object PaginationLink
  The pagination links.

{
    "type":"array",
    "description":"The array of pagination items.",
    "items":{
        "$ref":"#/definitions/PaginationLink"
    }
}

Nested Schema : Participant

Type: object

The details of the participant.

Show Source

• invitedBy: string
  The login of the user who invited the participant to the chat or conference. This field is present only for the chats started by a user.
• invitedTime: string
  The time (in UTC time zone) when the participant was invited to a chat or conference. The time is specified in 'YYYY-MM-DD HH:MM:SS' format.
• leftTime: string
  The time (in UTC time zone) when the participant left the chat. The time is specified in 'YYYY-MM-DD HH:MM:SS' format.
• login: string
  The login of the participant.
• name: string
  The name of the participant.
• online: boolean
  Contains one of the following values: true or false. If true, then the participant is online. If false, then then the participant is not online.
• present: boolean
  Contains one of the following values: true or false. If true, then the participant is present in the chat. If false, then then the participant is not present in the chat.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the participant."
        },
        "login":{
            "type":"string",
            "description":"The login of the participant."
        },
        "present":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the participant is present in the chat. If false, then then the participant is not present in the chat."
        },
        "online":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the participant is online. If false, then then the participant is not online. "
        },
        "invitedBy":{
            "type":"string",
            "description":"The login of the user who invited the participant to the chat or conference. This field is present only for the chats started by a user."
        },
        "invitedTime":{
            "type":"string",
            "description":"The time (in UTC time zone) when the participant was invited to a chat or conference. The time is specified in 'YYYY-MM-DD HH:MM:SS' format."
        },
        "leftTime":{
            "type":"string",
            "description":"The time (in UTC time zone) when the participant left the chat. The time is specified in 'YYYY-MM-DD HH:MM:SS' format."
        }
    },
    "description":"The details of the participant."
}

Nested Schema : PaginationLink

Type: object

The pagination links.

Show Source

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"The pagination links."
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to retrieve the participants of an existing chat by submitting a GET request on the REST resource:

cURL command Example

The following shows an example of the cURL command.

curl -X GET "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCollaboration/v1/chats/1/participants" -H "Accept: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...B2A_Zl7o6M7UpDmBK8EA" -H "Content-Type: application/json"

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 22 Apr 2019 16:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

The following shows an example of the response body in JSON format.

{
    "totalResults": 2,
    "limit": 10,
    "offset": 0,
    "items": [
        {
            "name": "John Smith",
            "login": "smith",
            "present": true,
            "online": false,
            "invitedBy": "williams",
            "invitedTime": "2019-04-22 14:03:41",
            "leftTime": ""
        },
        {
            "name": "Robert Williams",
            "login": "williams",
            "present": true,
            "online": true,
            "invitedBy": "williams",
            "invitedTime": "2019-04-22 14:03:41",
            "leftTime": ""
        }        
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCollaboration/v1/chats/1/participants/"
        }
    ]
}

Back to Top