Team—Get List of Phone Books

This API allows an administrator to get a list of phone books assigned to a specific team. The list is in the same format as defined in the section PhoneBook.

URI:

https://<FQDN>/finesse/api/Team/<id>/PhoneBooks

Example URI:

https://finesse1.xyz.com/finesse/api/Team/574/PhoneBooks

Security Constraints:

Only administrators can use this API.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

400: Bad Request

400: Finesse API Error

401: Authorization Failure

403: Forbidden

404: Not Found

500: Internal Server Error

Example Response: 

<PhoneBooks>
      <PhoneBook>
           ... Full PhoneBook Object ...
      </PhoneBook>
      <PhoneBook>
           ... Full PhoneBook Object ...
      </PhoneBook>
      <PhoneBook>
           ... Full PhoneBook Object ...
      </PhoneBook>
....
</PhoneBooks>

Example Failure Response: 

<ApiErrors>
     <ApiError>
          <ErrorData>574</ErrorData>
          <ErrorType>finesse.api.team.team_assignment_invalid_
           team&</ErrorType>
          <ErrorMessage>HTTP Status code: 404 (Not Found) 
           Api Error Type:finesse.api.team.team_assignment_
           invalid_team 
           Error Message: 
           This is not a valid team</ErrorMessage>
     </ApiError>
</ApiErrors>