POST api/orgEntity/header

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EntityID	integer	None.
EntityName	string	None.
ShortName	string	None.
OnPropackHold	boolean	None.
OnCreditHold	boolean	None.
IsActive	boolean	None.
EntityType	string	None.
AssociatedEntityID	integer	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,
  "EntityID": 1,
  "EntityName": "sample string 2",
  "ShortName": "sample string 3",
  "OnPropackHold": true,
  "OnCreditHold": true,
  "IsActive": true,
  "EntityType": "sample string 7",
  "AssociatedEntityID": 8,
  "CreatedBy": 9,
  "CreatedDate": "2025-12-06T23:37:07.0197813+00:00",
  "UpdatedBy": 11,
  "UpdatedDate": "2025-12-06T23:37:07.0197813+00:00"
}

application/xml, text/xml

Sample:

<orgEntityHeader 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" />
  <AssociatedEntityID>8</AssociatedEntityID>
  <CreatedBy>9</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:37:07.0197813Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <EntityID>1</EntityID>
  <EntityName>sample string 2</EntityName>
  <EntityType>sample string 7</EntityType>
  <IsActive>true</IsActive>
  <OnCreditHold>true</OnCreditHold>
  <OnPropackHold>true</OnPropackHold>
  <ShortName>sample string 3</ShortName>
  <UpdatedBy>11</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:37:07.0197813Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</orgEntityHeader>

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

Response Information

Resource Description

UpsertRetOforgEntityHeader

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

Response Formats

application/json, text/json

Sample:

{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "EntityID": 1,
    "EntityName": "sample string 2",
    "ShortName": "sample string 3",
    "OnPropackHold": true,
    "OnCreditHold": true,
    "IsActive": true,
    "EntityType": "sample string 7",
    "AssociatedEntityID": 8,
    "CreatedBy": 9,
    "CreatedDate": "2025-12-06T23:37:07.0197813+00:00",
    "UpdatedBy": 11,
    "UpdatedDate": "2025-12-06T23:37:07.0197813+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<UpsertRetOforgEntityHeader_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:AssociatedEntityID>8</d2p1:AssociatedEntityID>
    <d2p1:CreatedBy>9</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:07.0197813Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:EntityID>1</d2p1:EntityID>
    <d2p1:EntityName>sample string 2</d2p1:EntityName>
    <d2p1:EntityType>sample string 7</d2p1:EntityType>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:OnCreditHold>true</d2p1:OnCreditHold>
    <d2p1:OnPropackHold>true</d2p1:OnPropackHold>
    <d2p1:ShortName>sample string 3</d2p1:ShortName>
    <d2p1:UpdatedBy>11</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:07.0197813Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
  </returnItem>
</UpsertRetOforgEntityHeader_S0MPMsnQ>