POST api/orders/{orderNumber}/copyattachments

Copies a previously uploaded attachment to a previously created work order.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderNumber

Work order number.

 integer

Required

Body Parameters

Structure describing the attachment(s) to copy.

OrderAttachmentCopyRequest
NameDescriptionTypeAdditional information
Details

An array of structures detailing the source attachments.

 Collection of OrderAttachmentCopyDetail

Required

Min length: 1

Request Formats

application/json, text/json

Sample: 
{
  "Details": [
    {
      "AttachmentType": 21,
      "SourceAttachment": "b5631e58-a065-456f-bc9b-2067c658d869",
      "DesiredFilename": "sample string 2",
      "Description": "sample string 3"
    },
    {
      "AttachmentType": 21,
      "SourceAttachment": "b5631e58-a065-456f-bc9b-2067c658d869",
      "DesiredFilename": "sample string 2",
      "Description": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<OrderAttachmentCopyRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Details>
    <OrderAttachmentCopyDetail>
      <AttachmentType>DeliveryInstructions</AttachmentType>
      <SourceAttachment>b5631e58-a065-456f-bc9b-2067c658d869</SourceAttachment>
      <DesiredFilename>sample string 2</DesiredFilename>
      <Description>sample string 3</Description>
    </OrderAttachmentCopyDetail>
    <OrderAttachmentCopyDetail>
      <AttachmentType>DeliveryInstructions</AttachmentType>
      <SourceAttachment>b5631e58-a065-456f-bc9b-2067c658d869</SourceAttachment>
      <DesiredFilename>sample string 2</DesiredFilename>
      <Description>sample string 3</Description>
    </OrderAttachmentCopyDetail>
  </Details>
</OrderAttachmentCopyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderAttachmentCopyResponse
NameDescriptionTypeAdditional information
SuccessLevel

Indicator of how successful the copy process was.

 OrderAttachmentCopyResponseSuccessLevel

None.

Response Formats

application/json, text/json

Sample: 
{
  "SuccessLevel": 0
}

application/xml, text/xml

Sample: 
<OrderAttachmentCopyResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SuccessLevel>None</SuccessLevel>
</OrderAttachmentCopyResponse>