PhoneBook—Export Contact List

This API allows an administrator to export a list of contacts that belong to a specific phone book. The list is exported in CSV format.

URI:

https://<FQDN>/finesse/api/PhoneBook/<id>/Contacts/csvFileContent

Example URI:

https://finesse1.xyz.com/finesse/api/PhoneBook/34/Contacts/csvFileContent

Security Constraints:

Only administrators can use this API.

HTTP Method:

GET

Content Type:

text/CSV

Input/Output Format:

Multipart/form-data type=file

Example Exported CSV File:

"First Name","Last Name","Phone Number","Notes" 
"Amanda","Cohen","6511234","" 
"Nicholas","Knight","6125551228","Sales" 
"Natalie","Lambert","9525559876","Benefits" 
"Joseph","Stonetree","6515557612","Manager"

HTTP Response:

200: Success

Note	This response indicates a successful completion of the request. After a successful request, browser clients are prompted to save the returned content as a CSV file.

400: Finesse API Error

401: Authorization Failure

403: Forbidden

404: Not Found

500: Internal Server Error

Example Failure Response:

<ApiErrors>
     <ApiError>
          <ErrorType>Authorization Failure</ErrorType>
          <ErrorMessage>UNAUTHORIZED</ErrorMessage>
          <ErrorData>jsmith</ErrorData>        
     </ApiError>
</ApiErrors>