GET api/unitemails/{emailId}/attachments

Get attachments by email id

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
emailId

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

UnitEmailAttachment
NameDescriptionTypeAdditional information
UnitsEmailsAttachmentsId

Units Emails Attachments Id. Primary key of the units email attachments table.

 integer

None.
EmailId

Email Id.

 integer

None.
PropertyId

Property Id. See the GET api/properties/{propertyId} route to get the property data.

 integer

None.
Name

Attachment Name

 string

None.
PathToFile

Attachment Path. To get the file use api/files?filePath={value in this property}

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "UnitsEmailsAttachmentsId": 1,
  "EmailId": 2,
  "PropertyId": 3,
  "Name": "sample string 4",
  "PathToFile": "sample string 5"
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)