GET contact_information/profile_photo/view

Available from CRM.COM R11.0.0

This method returns the profile photo information related with a contact information

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Identifier

The identifier of the contact information that should be retrieved. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

fields_set
(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify at least one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "data": {
    "file_name": "217F456047A749728A263BEC2A472003_key_contacts-profilephoto_images.jpg",
    "file_content_url": "/crm/ImageDownloadServlet?id=217F456047A749728A263BEC2A472003",
    "file_mime_type": "image/jpeg"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Note:

To retrieve or display the actual image you need to construct the following URL

{{server}}{{file_content_url}}&token={{token}}

for example

https://r11qa.crm.com/crm/ImageDownloadServlet?id=217F456047A749728A263BEC2A472003&token=B18ECEE5918442A0A29B7C1B2D0A4260