Visual FoxPro Zendesk: Upload an Attachment File

Back to Index

Uploads an attachment file.

Documentation: https://developer.zendesk.com/rest_api/docs/core/attachments#upload-files

CURL Command

curl -X POST https://subdomain.zendesk.com/api/v2/uploads.json?filename=sample.pdf \
  -H "Content-Type: application/binary" \
  --data-binary @sample.pdf \
  -u zendesk_email:zendesk_password

Visual FoxPro Example

LOCAL loRest
LOCAL lnSuccess
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL loFileStream
LOCAL lcStrResponseBody
LOCAL lnRespStatusCode
LOCAL loJsonResponse
LOCAL lcUploadToken
LOCAL lcUploadExpires_at
LOCAL lcUploadAttachmentUrl
LOCAL lnUploadAttachmentId
LOCAL lcUploadAttachmentFile_name
LOCAL lcUploadAttachmentContent_url
LOCAL lcUploadAttachmentMapped_content_url
LOCAL lcUploadAttachmentContent_type
LOCAL lnUploadAttachmentSize
LOCAL lcUploadAttachmentWidth
LOCAL lcUploadAttachmentHeight
LOCAL lnUploadAttachmentInline
LOCAL i
LOCAL lnCount_i
LOCAL lcUrl
LOCAL lnId
LOCAL lcFile_name
LOCAL lcContent_url
LOCAL lcMapped_content_url
LOCAL lcContent_type
LOCAL lnSize
LOCAL lcWidth
LOCAL lcHeight
LOCAL lnInline
LOCAL j
LOCAL lnCount_j

loRest = CreateObject('Chilkat_9_5_0.Rest')

*  URL: https://subdomain.zendesk.com/api/v2/uploads.json?filename=sample.pdf
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("subdomain.zendesk.com",lnPort,lnBTls,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? "ConnectFailReason: " + STR(loRest.ConnectFailReason)
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

loRest.SetAuthBasic("zendesk_email","zendesk_password")

loFileStream = CreateObject('Chilkat_9_5_0.Stream')
loFileStream.SourceFile = "sample.pdf"

loRest.AddHeader("Content-Type","application/binary")

lcStrResponseBody = loRest.FullRequestStream("POST","/api/v2/uploads.json?filename=sample.pdf",loFileStream)
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loFileStream
    CANCEL
ENDIF

lnRespStatusCode = loRest.ResponseStatusCode
IF (lnRespStatusCode >= 400) THEN
    ? "Response Status Code = " + STR(lnRespStatusCode)
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? lcStrResponseBody
    RELEASE loRest
    RELEASE loFileStream
    CANCEL
ENDIF

loJsonResponse = CreateObject('Chilkat_9_5_0.JsonObject')
loJsonResponse.Load(lcStrResponseBody)

lcUploadToken = loJsonResponse.StringOf("upload.token")
lcUploadExpires_at = loJsonResponse.StringOf("upload.expires_at")
lcUploadAttachmentUrl = loJsonResponse.StringOf("upload.attachment.url")
lnUploadAttachmentId = loJsonResponse.IntOf("upload.attachment.id")
lcUploadAttachmentFile_name = loJsonResponse.StringOf("upload.attachment.file_name")
lcUploadAttachmentContent_url = loJsonResponse.StringOf("upload.attachment.content_url")
lcUploadAttachmentMapped_content_url = loJsonResponse.StringOf("upload.attachment.mapped_content_url")
lcUploadAttachmentContent_type = loJsonResponse.StringOf("upload.attachment.content_type")
lnUploadAttachmentSize = loJsonResponse.IntOf("upload.attachment.size")
lcUploadAttachmentWidth = loJsonResponse.StringOf("upload.attachment.width")
lcUploadAttachmentHeight = loJsonResponse.StringOf("upload.attachment.height")
lnUploadAttachmentInline = loJsonResponse.BoolOf("upload.attachment.inline")
i = 0
lnCount_i = loJsonResponse.SizeOfArray("upload.attachments")
DO WHILE i < lnCount_i
    loJsonResponse.I = i
    lcUrl = loJsonResponse.StringOf("upload.attachments[i].url")
    lnId = loJsonResponse.IntOf("upload.attachments[i].id")
    lcFile_name = loJsonResponse.StringOf("upload.attachments[i].file_name")
    lcContent_url = loJsonResponse.StringOf("upload.attachments[i].content_url")
    lcMapped_content_url = loJsonResponse.StringOf("upload.attachments[i].mapped_content_url")
    lcContent_type = loJsonResponse.StringOf("upload.attachments[i].content_type")
    lnSize = loJsonResponse.IntOf("upload.attachments[i].size")
    lcWidth = loJsonResponse.StringOf("upload.attachments[i].width")
    lcHeight = loJsonResponse.StringOf("upload.attachments[i].height")
    lnInline = loJsonResponse.BoolOf("upload.attachments[i].inline")
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("upload.attachments[i].thumbnails")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    i = i + 1
ENDDO
i = 0
lnCount_i = loJsonResponse.SizeOfArray("upload.attachment.thumbnails")
DO WHILE i < lnCount_i
    loJsonResponse.I = i
    i = i + 1
ENDDO

RELEASE loRest
RELEASE loFileStream
RELEASE loJsonResponse

Sample JSON Response Body

{
  "upload": {
    "token": "W7Y11FCxfQlzOFPDbVDUEE45C",
    "expires_at": "2018-04-18T20:03:56Z",
    "attachments": [
      {
        "url": "https://chilkat.zendesk.com/api/v2/attachments/360887735934.json",
        "id": 360887735934,
        "file_name": "sample.pdf",
        "content_url": "https://chilkat.zendesk.com/attachments/token/Q7wAubpKB2KERnNFj89JmdvS1/?name=sample.pdf",
        "mapped_content_url": "https://chilkat.zendesk.com/attachments/token/Q7wAubpKB2KERnNFj89JmdvS1/?name=sample.pdf",
        "content_type": "application/pdf",
        "size": 178399,
        "width": null,
        "height": null,
        "inline": false,
        "thumbnails": [
        ]
      }
    ],
    "attachment": {
      "url": "https://chilkat.zendesk.com/api/v2/attachments/360887735934.json",
      "id": 360887735934,
      "file_name": "sample.pdf",
      "content_url": "https://chilkat.zendesk.com/attachments/token/Q7wAubpKB2KERnNFj89JmdvS1/?name=sample.pdf",
      "mapped_content_url": "https://chilkat.zendesk.com/attachments/token/Q7wAubpKB2KERnNFj89JmdvS1/?name=sample.pdf",
      "content_type": "application/pdf",
      "size": 178399,
      "width": null,
      "height": null,
      "inline": false,
      "thumbnails": [
      ]
    }
  }
}