PUT api/ordNote/{id}

Update an existing record from the Notes table.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

ordNoteDb
NameDescriptionTypeAdditional information
NoteID

integer

None.

NoteTypeID

NoteType

Required

OrderID

integer

Required

ItemID

integer

None.

ItemType

OrdLinkType

None.

InvoiceID

integer

None.

FreightLegID

integer

None.

FreightPayableID

integer

None.

FreightFeeID

integer

None.

FreightHandlingID

integer

None.

TaskID

integer

None.

TrackingID

integer

None.

WarehouseAlertID

integer

None.

QuoteID

integer

None.

WONumber

integer

None.

Note

string

Required

ClientVisible

boolean

None.

IsRead

boolean

None.

CreatedBy

integer

None.

CreatedDate

date

None.

UpdatedBy

integer

None.

UpdatedDate

date

None.

results

Collection of ValidationResult

None.

Request Formats

application/json, text/json

Sample:
{
  "results": null,
  "NoteID": 1,
  "NoteTypeID": 0,
  "OrderID": 2,
  "ItemID": 1,
  "ItemType": 1,
  "InvoiceID": 1,
  "FreightLegID": 1,
  "FreightPayableID": 1,
  "FreightFeeID": 1,
  "FreightHandlingID": 1,
  "TaskID": 1,
  "TrackingID": 1,
  "WarehouseAlertID": 1,
  "QuoteID": 1,
  "WONumber": 1,
  "Note": "sample string 3",
  "ClientVisible": true,
  "IsRead": true,
  "CreatedBy": 6,
  "CreatedDate": "2025-12-06T23:42:55.4594057+00:00",
  "UpdatedBy": 8,
  "UpdatedDate": "2025-12-06T23:42:55.4594057+00:00"
}

application/xml, text/xml

Sample:
<ordNoteDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <ClientVisible>true</ClientVisible>
  <CreatedBy>6</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:55.4594057Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <FreightFeeID>1</FreightFeeID>
  <FreightHandlingID>1</FreightHandlingID>
  <FreightLegID>1</FreightLegID>
  <FreightPayableID>1</FreightPayableID>
  <InvoiceID>1</InvoiceID>
  <IsRead>true</IsRead>
  <ItemID>1</ItemID>
  <ItemType>Order</ItemType>
  <Note>sample string 3</Note>
  <NoteID>1</NoteID>
  <NoteTypeID>All</NoteTypeID>
  <OrderID>2</OrderID>
  <QuoteID>1</QuoteID>
  <TaskID>1</TaskID>
  <TrackingID>1</TrackingID>
  <UpdatedBy>8</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:42:55.4594057Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
  <WONumber>1</WONumber>
  <WarehouseAlertID>1</WarehouseAlertID>
</ordNoteDb>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ordNoteDb'.

Response Information

Resource Description

UpsertRetOfordNoteDb
NameDescriptionTypeAdditional information
returnID

integer

None.

results

Collection of ValidationResult

None.

returnItem

ordNoteDb

None.

displayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "NoteID": 1,
    "NoteTypeID": 0,
    "OrderID": 2,
    "ItemID": 1,
    "ItemType": 1,
    "InvoiceID": 1,
    "FreightLegID": 1,
    "FreightPayableID": 1,
    "FreightFeeID": 1,
    "FreightHandlingID": 1,
    "TaskID": 1,
    "TrackingID": 1,
    "WarehouseAlertID": 1,
    "QuoteID": 1,
    "WONumber": 1,
    "Note": "sample string 3",
    "ClientVisible": true,
    "IsRead": true,
    "CreatedBy": 6,
    "CreatedDate": "2025-12-06T23:42:55.4594057+00:00",
    "UpdatedBy": 8,
    "UpdatedDate": "2025-12-06T23:42:55.4594057+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<UpsertRetOfordNoteDb_S0MPMsnQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <displayMessage>sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
  <returnID>1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:ClientVisible>true</d2p1:ClientVisible>
    <d2p1:CreatedBy>6</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:55.4594057Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:FreightFeeID>1</d2p1:FreightFeeID>
    <d2p1:FreightHandlingID>1</d2p1:FreightHandlingID>
    <d2p1:FreightLegID>1</d2p1:FreightLegID>
    <d2p1:FreightPayableID>1</d2p1:FreightPayableID>
    <d2p1:InvoiceID>1</d2p1:InvoiceID>
    <d2p1:IsRead>true</d2p1:IsRead>
    <d2p1:ItemID>1</d2p1:ItemID>
    <d2p1:ItemType>Order</d2p1:ItemType>
    <d2p1:Note>sample string 3</d2p1:Note>
    <d2p1:NoteID>1</d2p1:NoteID>
    <d2p1:NoteTypeID>All</d2p1:NoteTypeID>
    <d2p1:OrderID>2</d2p1:OrderID>
    <d2p1:QuoteID>1</d2p1:QuoteID>
    <d2p1:TaskID>1</d2p1:TaskID>
    <d2p1:TrackingID>1</d2p1:TrackingID>
    <d2p1:UpdatedBy>8</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:42:55.4594057Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
    <d2p1:WONumber>1</d2p1:WONumber>
    <d2p1:WarehouseAlertID>1</d2p1:WarehouseAlertID>
  </returnItem>
</UpsertRetOfordNoteDb_S0MPMsnQ>