PUT api/orgDocument/{id}

Update an existing record from the ord.Documents table.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

orgDocument

Name	Type	Additional information
DocumentID	integer	None.
OrgItemTypeID	OrgItemType	Required
EntityID	integer	None.
PlaceID	integer	None.
PersonID	integer	None.
EmailID	integer	None.
PhoneID	integer	None.
MediaID	integer	None.
DocumentName	string	Max length: 240
DocumentPath	string	Max length: 240
DocumentDescription	string	Max length: 3000
ContentType	string	None.
ClientVisible	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,
  "DocumentID": 1,
  "OrgItemTypeID": 1,
  "EntityID": 1,
  "PlaceID": 1,
  "PersonID": 1,
  "EmailID": 1,
  "PhoneID": 1,
  "MediaID": 1,
  "DocumentName": "sample string 2",
  "DocumentPath": "sample string 3",
  "DocumentDescription": "sample string 4",
  "ContentType": "sample string 5",
  "ClientVisible": true,
  "CreatedBy": 7,
  "CreatedDate": "2025-12-06T23:39:29.9967405+00:00",
  "UpdatedBy": 9,
  "UpdatedDate": "2025-12-06T23:39:29.9967405+00:00"
}

application/xml, text/xml

Sample:

<orgDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <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>
  <ContentType>sample string 5</ContentType>
  <CreatedBy>7</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:39:29.9967405Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DocumentDescription>sample string 4</DocumentDescription>
  <DocumentID>1</DocumentID>
  <DocumentName>sample string 2</DocumentName>
  <DocumentPath>sample string 3</DocumentPath>
  <EmailID>1</EmailID>
  <EntityID>1</EntityID>
  <MediaID>1</MediaID>
  <OrgItemTypeID>Entity</OrgItemTypeID>
  <PersonID>1</PersonID>
  <PhoneID>1</PhoneID>
  <PlaceID>1</PlaceID>
  <UpdatedBy>9</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:39:29.9967405Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</orgDocument>

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 'orgDocument'.

Response Information

Resource Description

UpsertRetOforgDocument

Name	Type	Additional information
returnID	integer	None.
results	Collection of ValidationResult	None.
returnItem	orgDocument	None.
displayMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "DocumentID": 1,
    "OrgItemTypeID": 1,
    "EntityID": 1,
    "PlaceID": 1,
    "PersonID": 1,
    "EmailID": 1,
    "PhoneID": 1,
    "MediaID": 1,
    "DocumentName": "sample string 2",
    "DocumentPath": "sample string 3",
    "DocumentDescription": "sample string 4",
    "ContentType": "sample string 5",
    "ClientVisible": true,
    "CreatedBy": 7,
    "CreatedDate": "2025-12-06T23:39:29.9967405+00:00",
    "UpdatedBy": 9,
    "UpdatedDate": "2025-12-06T23:39:29.9967405+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<UpsertRetOforgDocument66KPc_SrH 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.Tables">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:ClientVisible>true</d2p1:ClientVisible>
    <d2p1:ContentType>sample string 5</d2p1:ContentType>
    <d2p1:CreatedBy>7</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:29.9967405Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:DocumentDescription>sample string 4</d2p1:DocumentDescription>
    <d2p1:DocumentID>1</d2p1:DocumentID>
    <d2p1:DocumentName>sample string 2</d2p1:DocumentName>
    <d2p1:DocumentPath>sample string 3</d2p1:DocumentPath>
    <d2p1:EmailID>1</d2p1:EmailID>
    <d2p1:EntityID>1</d2p1:EntityID>
    <d2p1:MediaID>1</d2p1:MediaID>
    <d2p1:OrgItemTypeID>Entity</d2p1:OrgItemTypeID>
    <d2p1:PersonID>1</d2p1:PersonID>
    <d2p1:PhoneID>1</d2p1:PhoneID>
    <d2p1:PlaceID>1</d2p1:PlaceID>
    <d2p1:UpdatedBy>9</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:29.9967405Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
  </returnItem>
</UpsertRetOforgDocument66KPc_SrH>