GET api/shipments/attachments/{shipId}/{fieldName}

Request Information

URI Parameters

Name	Description	Type	Additional information
shipId		integer	Required
fieldName		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipAttachmentModel

Name	Type	Additional information
Id	integer	None.
ShipId	integer	None.
FieldName	string	None.
FileName	string	None.
FileSize	decimal number	None.
UploadDate	date	None.
FileType	string	None.
Description	string	None.
File	Stream	None.
Uploaded	boolean	None.
ValidationErrors	string	None.
SaveState	enuState	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ShipId": 2,
  "FieldName": "sample string 3",
  "FileName": "sample string 4",
  "FileSize": 5.1,
  "UploadDate": "2025-10-14T08:20:05.9862789+00:00",
  "FileType": "sample string 7",
  "Description": "sample string 8",
  "File": null,
  "Uploaded": true,
  "ValidationErrors": "sample string 10",
  "SaveState": 0
}

application/xml, text/xml

Sample:

<ShipAttachmentModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SaveState>Unchanged</SaveState>
  <Id>1</Id>
  <ShipId>2</ShipId>
  <FieldName>sample string 3</FieldName>
  <FileName>sample string 4</FileName>
  <FileSize>5.1</FileSize>
  <UploadDate>2025-10-14T08:20:05.9862789+00:00</UploadDate>
  <FileType>sample string 7</FileType>
  <Description>sample string 8</Description>
  <Uploaded>true</Uploaded>
  <ValidationErrors>sample string 10</ValidationErrors>
</ShipAttachmentModel>