Service Provider API-Guide

Download As PDF

API Details for GET WorkOrder Attachment

Gets the attachments associated with the specified WorkOrder and its invoice and quote, consumes the WO number or ID as a parameter. The information about the attachments becomes available as a collection of the JSON objects. This entry point returns the information about all the attachments of the given WorkOrder, cross the WorkOrder itself, and all its invoices and quotes. If the attachments are discovered on the Invoice (or Quote) level, they have their InvoiceId field (or respectfully QuoteId field) presenting the id.

GET api/WorkOrders/{id}/Attachments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None

Response Information

Resource Description

Collection of ExternalAttachment
NameDescriptionTypeAdditional information
WorkOrderNumber

string None.
Id

integer None.
InvoiceId

integer None.
QuoteId

integer None.
Name

string None.
Path

string None.
URL

string None.
Username

string None.
CreatedDate

date None.
FormattedCreatedDate

string None.
SizeString

string None.
Latitude

string None.
Longitude

string None.
Description

string None.
FileExtention

string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "WorkOrderNumber": "sample string 1",
    "Id": 2,
    "InvoiceId": 1,
    "QuoteId": 1,
    "Name": "sample string 3",
    "Path": "sample string 4",
    "URL": "sample string 5",
    "Username": "sample string 6",
    "CreatedDate": "2025-04-30T01:51:27.0684466Z",
    "FormattedCreatedDate": "4/30/2025",
    "SizeString": "0.00 mb",
    "Latitude": "sample string 10",
    "Longitude": "sample string 11",
    "Description": "sample string 12",
    "FileExtention": "sample string 13"
  },
  {
    "WorkOrderNumber": "sample string 1",
    "Id": 2,
    "InvoiceId": 1,
    "QuoteId": 1,
    "Name": "sample string 3",
    "Path": "sample string 4",
    "URL": "sample string 5",
    "Username": "sample string 6",
    "CreatedDate": "2025-04-30T01:51:27.0684466Z",
    "FormattedCreatedDate": "4/30/2025",
    "SizeString": "0.00 mb",
    "Latitude": "sample string 10",
    "Longitude": "sample string 11",
    "Description": "sample string 12",
    "FileExtention": "sample string 13"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.