Get a List of Attachments

This service lists information about any attachments to the requested entity.

Query String Parameters

Name	Type	Description	Required
Action	String	ListAttachments	Required
Type	String	Attachment Type Name, for example 'job'.	Required
EntityID	String	Entity ID. For example, when using the Contact type, this would be the ContactID. EntityID takes precedence over EntityRef if both parameters are supplied.	Required
EntityRef	String	Entity Reference – for example, when using the Contact Type, this would be the Contact Reference.	Required

Response Codes

Code	Message	Information
0	Response Data
2	type parameter expected
2	Misc.Lang(misc_noRight
2	Library Attachments Not Implemented
2	Type should be contact/job/invoice/InvoiceAttachment/Stockitem/WorksheetAnswer/ContactNote/Stock/Resource/ResourcePhoto/Contract
2	entityRef or entityId parameter expected
2	Invalid format EntityId
2	Contact not found
2	Job not found
2	JobGroup not found
2	Invalid type
2	Invoice not found
2	stockitem not found
2	You must supply an entityId
2	Contact Note not found
2	Asset not found
2	Resource not found
2	Library Attachment listing Not Implemented
2	Contract not found
2	SalesOpportunity not found

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=action=ListAttachments&Type=job&EntityId=126209701

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "attachmentId": 370793549,
      "attachmentDescription": "sample-clouds-400x300.jpg",
      "attachmentFileId": "723b64b1-cdeb-4a87-b6eb-1effa8438085",
      "attachmentFileType": "image/jpeg",
      "attachmentFileExt": "jpg",
      "attachmentDateCreated": "2024-08-29 16:54:46"
    }
  ]
}