Chilkat Online Tools

DataFlex / Salesforce Platform APIs / User Photo

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vReq
    Handle hoReq
    Variant vJsonFormData1
    Handle hoJsonFormData1
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sFullEmailPhotoUrl
    String sLargePhotoUrl
    String sMediumPhotoUrl
    String sPhotoVersionId
    String sSmallPhotoUrl
    String sStandardEmailPhotoUrl
    String sUrl
    String sTemp1
    Boolean bTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End
    Set ComHttpVerb Of hoReq To "POST"
    Set ComPath Of hoReq To "/services/data/v{{version}}/connect/user-profiles/me/photo"
    Set ComContentType Of hoReq To "multipart/form-data"

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonFormData1
    If (Not(IsComObjectCreated(hoJsonFormData1))) Begin
        Send CreateComObject of hoJsonFormData1
    End
    Get ComUpdateString Of hoJsonFormData1 "cropY" "0" To iSuccess
    Get ComUpdateString Of hoJsonFormData1 "cropX" "0" To iSuccess
    Get ComUpdateString Of hoJsonFormData1 "cropSize" "200" To iSuccess
    Get pvComObject of hoJsonFormData1 to vJsonFormData1
    Get ComAddStringForUpload2 Of hoReq "json" "" vJsonFormData1 "utf-8" "application/json" To iSuccess

    Get ComAddFileForUpload2 Of hoReq "fileUpload" " path to file" "application/octet-stream" To iSuccess

    Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
    Send ComAddHeader To hoReq "Content-Disposition" 'form-data; name="photo"'
    Send ComAddHeader To hoReq "Expect" "100-continue"

    Get pvComObject of hoReq to vReq
    Get ComSynchronousRequest Of hoHttp "domain.com" 443 True vReq To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
    //   "largePhotoUrl": "https://<my_domain>/profilephoto/729.../F",
    //   "mediumPhotoUrl": "https://<my_domain>/profilephoto/729.../M",
    //   "photoVersionId": "729...",
    //   "smallPhotoUrl": "https://<my_domain>/profilephoto/729.../T",
    //   "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
    //   "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Get ComStringOf Of hoJResp "fullEmailPhotoUrl" To sFullEmailPhotoUrl
    Get ComStringOf Of hoJResp "largePhotoUrl" To sLargePhotoUrl
    Get ComStringOf Of hoJResp "mediumPhotoUrl" To sMediumPhotoUrl
    Get ComStringOf Of hoJResp "photoVersionId" To sPhotoVersionId
    Get ComStringOf Of hoJResp "smallPhotoUrl" To sSmallPhotoUrl
    Get ComStringOf Of hoJResp "standardEmailPhotoUrl" To sStandardEmailPhotoUrl
    Get ComStringOf Of hoJResp "url" To sUrl


End_Procedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	-H "Content-Disposition: form-data; name=\"photo\""
	-H "Content-Type: application/json; charset=UTF-8"
	--form 'json={"cropY":"0","cropX":"0","cropSize":"200"}'
	--form 'fileUpload=@"/path/to/file"'
https://domain.com/services/data/v{{version}}/connect/user-profiles/me/photo

Postman Collection Item JSON

{
  "name": "User Photo",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data",
        "disabled": true
      },
      {
        "key": "Content-Disposition",
        "value": "form-data; name=\"photo\"",
        "disabled": true
      },
      {
        "key": "Content-Type",
        "value": "application/json; charset=UTF-8",
        "disabled": true
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "json",
          "value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}",
          "type": "text"
        },
        {
          "key": "fileUpload",
          "type": "file",
          "src": [
          ]
        }
      ]
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "user-profiles",
        "me",
        "photo"
      ]
    },
    "description": "Get, post, and crop a user photo.\nTo use an image from the Files page as a user photo, pass the file ID in the fileId property of the request body or in the fileId request parameter. Images uploaded on the User page don’t have a file ID and can’t be used as the fileId.\n\nTo upload a binary file as the user photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see Uploading Binary Files.\n\nTo display user profile photos in a feed, cache the user photos. Then use the photoVersionId property of the Photo response body to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance."
  },
  "response": [
    {
      "name": "Succesful User Photo",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "multipart/form-data",
            "disabled": true
          },
          {
            "key": "Content-Disposition",
            "value": "form-data; name=\"photo\"",
            "disabled": true
          },
          {
            "key": "Content-Type",
            "value": "application/json; charset=UTF-8",
            "disabled": true
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "json",
              "value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}",
              "type": "text"
            },
            {
              "key": "fileUpload",
              "type": "file",
              "src": "/Users/scolladon/Downloads/1x1.png"
            }
          ]
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "user-profiles",
            "me",
            "photo"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:15:44 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n    \"largePhotoUrl\": \"https://<my_domain>/profilephoto/729.../F\",\n    \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/729.../M\",\n    \"photoVersionId\": \"729...\",\n    \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/729.../T\",\n    \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n    \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n}"
    }
  ]
}