POST api/OpsLog/AttachDocument

Request Information

URI Parameters

None.

Body Parameters

uploadDocRequest
NameDescriptionTypeAdditional information
OrderNumber

integer

None.

uploadDocListLoop

Collection of uploadDocDetailsRequest

None.

PickupNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderNumber": 1,
  "uploadDocListLoop": [
    {
      "DocName": "sample string 1",
      "DocData": "sample string 2",
      "DocType": "sample string 3",
      "DocDetails": "sample string 4",
      "DocLocation": "sample string 5",
      "DocDateTime": "sample string 6"
    },
    {
      "DocName": "sample string 1",
      "DocData": "sample string 2",
      "DocType": "sample string 3",
      "DocDetails": "sample string 4",
      "DocLocation": "sample string 5",
      "DocDateTime": "sample string 6"
    }
  ],
  "PickupNumber": "sample string 2"
}

application/xml, text/xml

Sample:
<uploadDocRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderNumber>1</OrderNumber>
  <uploadDocListLoop>
    <uploadDocDetailsRequest>
      <DocName>sample string 1</DocName>
      <DocData>sample string 2</DocData>
      <DocType>sample string 3</DocType>
      <DocDetails>sample string 4</DocDetails>
      <DocLocation>sample string 5</DocLocation>
      <DocDateTime>sample string 6</DocDateTime>
    </uploadDocDetailsRequest>
    <uploadDocDetailsRequest>
      <DocName>sample string 1</DocName>
      <DocData>sample string 2</DocData>
      <DocType>sample string 3</DocType>
      <DocDetails>sample string 4</DocDetails>
      <DocLocation>sample string 5</DocLocation>
      <DocDateTime>sample string 6</DocDateTime>
    </uploadDocDetailsRequest>
  </uploadDocListLoop>
  <PickupNumber>sample string 2</PickupNumber>
</uploadDocRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ngltransProcessOrderResponse
NameDescriptionTypeAdditional information
OrderNumber

Gets or sets the order number.

integer

None.

PickupNumber

Gets or sets the order number.

string

None.

Status

Gets or sets the status.

nglStatusType

None.

ErrorMessage

string

None.

NexusEnableEmail

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderNumber": 1,
  "PickupNumber": "sample string 2",
  "Status": {
    "ResponseType": "sample string 4",
    "Code": "sample string 1",
    "Message": "sample string 3",
    "Id": 2
  },
  "ErrorMessage": "sample string 3",
  "NexusEnableEmail": true
}

application/xml, text/xml

Sample:
<ngltransProcessOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderNumber>1</OrderNumber>
  <PickupNumber>sample string 2</PickupNumber>
  <Status>
    <ResponseType>sample string 4</ResponseType>
    <Code>sample string 1</Code>
    <Message>sample string 3</Message>
    <Id>2</Id>
  </Status>
  <ErrorMessage>sample string 3</ErrorMessage>
  <NexusEnableEmail>true</NexusEnableEmail>
</ngltransProcessOrderResponse>