Jump to

• Request
• Response

Get address book

get

/rest/ofscCollaboration/v1/addressBook

This operation retrieves the address book.

Request

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 : AddressBookList

Type: object

The list of contacts from address book.

Show Source

• items: array items
  An array of items containing the contact 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 contacts retrieved.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of contacts 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 contact details.",
            "items":{
                "$ref":"#/definitions/Contact"
            }
        },
        "links":{
            "type":"array",
            "description":"The array of pagination items.",
            "items":{
                "$ref":"#/definitions/PaginationLink"
            }
        }
    },
    "description":"The list of contacts from address book."
}

Nested Schema : items

Type: array

An array of items containing the contact details.

Show Source

• Array of: object Contact
  Contact object

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

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 : Contact

Type: object

Contact object

Show Source

• contactId: string
  contact id or login id of the user
• name: string
  contact name
• online: boolean
  online status of the user
• type: string
  Allowed Values: [ "user", "helpdesk" ]

  type of user

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"contact name"
        },
        "online":{
            "type":"boolean",
            "description":"online status of the user"
        },
        "contactId":{
            "type":"string",
            "description":"contact id or login id of the user"
        },
        "type":{
            "type":"string",
            "description":"type of user",
            "enum":[
                "user",
                "helpdesk"
            ]
        }
    },
    "description":"Contact object"
}

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