POST api/ordAddress

Insert a new record into the Addresses table.

Request Information

URI Parameters

None.

Body Parameters

ordAddressDb
NameDescriptionTypeAdditional information
AddressID

integer

None.

AddressHash

Collection of byte

None.

ContactName

string

Max length: 100

EntityName

string

Max length: 100

PlaceName

string

Max length: 60

Address1

string

Max length: 50

Address2

string

Max length: 50

City

string

Max length: 50

PostalCode

string

Max length: 10

StateProvinceCode

string

Max length: 2

CountryCode

string

Max length: 3

AirportCode

string

Max length: 3

TollFree

string

Max length: 30

Phone

string

Max length: 30

Fax

string

Max length: 30

Mobile

string

Max length: 30

EMail

string

Max length: 60

Website

string

Max length: 60

OpenHours

string

None.

Comments

string

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,
  "AddressID": 1,
  "AddressHash": "QEA=",
  "ContactName": "sample string 2",
  "EntityName": "sample string 3",
  "PlaceName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "PostalCode": "sample string 8",
  "StateProvinceCode": "sample string 9",
  "CountryCode": "sample string 10",
  "AirportCode": "sample string 11",
  "TollFree": "sample string 12",
  "Phone": "sample string 13",
  "Fax": "sample string 14",
  "Mobile": "sample string 15",
  "EMail": "sample string 16",
  "Website": "sample string 17",
  "OpenHours": "sample string 18",
  "Comments": "sample string 19",
  "CreatedBy": 20,
  "CreatedDate": "2025-12-06T23:39:31.731123+00:00",
  "UpdatedBy": 22,
  "UpdatedDate": "2025-12-06T23:39:31.731123+00:00"
}

application/xml, text/xml

Sample:
<ordAddressDb 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" />
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <AddressHash>QEA=</AddressHash>
  <AddressID>1</AddressID>
  <AirportCode>sample string 11</AirportCode>
  <City>sample string 7</City>
  <Comments>sample string 19</Comments>
  <ContactName>sample string 2</ContactName>
  <CountryCode>sample string 10</CountryCode>
  <CreatedBy>20</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:39:31.731123Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <EMail>sample string 16</EMail>
  <EntityName>sample string 3</EntityName>
  <Fax>sample string 14</Fax>
  <Mobile>sample string 15</Mobile>
  <OpenHours>sample string 18</OpenHours>
  <Phone>sample string 13</Phone>
  <PlaceName>sample string 4</PlaceName>
  <PostalCode>sample string 8</PostalCode>
  <StateProvinceCode>sample string 9</StateProvinceCode>
  <TollFree>sample string 12</TollFree>
  <UpdatedBy>22</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:39:31.731123Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
  <Website>sample string 17</Website>
</ordAddressDb>

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

Response Information

Resource Description

UpsertRetOfordAddressEx
NameDescriptionTypeAdditional information
returnID

integer

None.

results

Collection of ValidationResult

None.

returnItem

ordAddressEx

None.

displayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "CreatedByInitials": "sample string 1",
    "CreatedByName": "sample string 2",
    "UpdatedByInitials": "sample string 3",
    "UpdatedByName": "sample string 4",
    "CountryName": "sample string 5",
    "AirportCSC": "sample string 6",
    "AddressID": 7,
    "AddressHash": "QEA=",
    "ContactName": "sample string 8",
    "EntityName": "sample string 9",
    "PlaceName": "sample string 10",
    "Address1": "sample string 11",
    "Address2": "sample string 12",
    "City": "sample string 13",
    "PostalCode": "sample string 14",
    "StateProvinceCode": "sample string 15",
    "CountryCode": "sample string 16",
    "AirportCode": "sample string 17",
    "TollFree": "sample string 18",
    "Phone": "sample string 19",
    "Fax": "sample string 20",
    "Mobile": "sample string 21",
    "EMail": "sample string 22",
    "Website": "sample string 23",
    "OpenHours": "sample string 24",
    "Comments": "sample string 25",
    "CreatedBy": 26,
    "CreatedDate": "2025-12-06T23:39:31.731123+00:00",
    "UpdatedBy": 28,
    "UpdatedDate": "2025-12-06T23:39:31.731123+00:00"
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<UpsertRetOfordAddressEx_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:Address1>sample string 11</d2p1:Address1>
    <d2p1:Address2>sample string 12</d2p1:Address2>
    <d2p1:AddressHash>QEA=</d2p1:AddressHash>
    <d2p1:AddressID>7</d2p1:AddressID>
    <d2p1:AirportCode>sample string 17</d2p1:AirportCode>
    <d2p1:City>sample string 13</d2p1:City>
    <d2p1:Comments>sample string 25</d2p1:Comments>
    <d2p1:ContactName>sample string 8</d2p1:ContactName>
    <d2p1:CountryCode>sample string 16</d2p1:CountryCode>
    <d2p1:CreatedBy>26</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:31.731123Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:EMail>sample string 22</d2p1:EMail>
    <d2p1:EntityName>sample string 9</d2p1:EntityName>
    <d2p1:Fax>sample string 20</d2p1:Fax>
    <d2p1:Mobile>sample string 21</d2p1:Mobile>
    <d2p1:OpenHours>sample string 24</d2p1:OpenHours>
    <d2p1:Phone>sample string 19</d2p1:Phone>
    <d2p1:PlaceName>sample string 10</d2p1:PlaceName>
    <d2p1:PostalCode>sample string 14</d2p1:PostalCode>
    <d2p1:StateProvinceCode>sample string 15</d2p1:StateProvinceCode>
    <d2p1:TollFree>sample string 18</d2p1:TollFree>
    <d2p1:UpdatedBy>28</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:31.731123Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
    <d2p1:Website>sample string 23</d2p1:Website>
    <d2p1:AirportCSC>sample string 6</d2p1:AirportCSC>
    <d2p1:CountryName>sample string 5</d2p1:CountryName>
    <d2p1:CreatedByInitials>sample string 1</d2p1:CreatedByInitials>
    <d2p1:CreatedByName>sample string 2</d2p1:CreatedByName>
    <d2p1:UpdatedByInitials>sample string 3</d2p1:UpdatedByInitials>
    <d2p1:UpdatedByName>sample string 4</d2p1:UpdatedByName>
  </returnItem>
</UpsertRetOfordAddressEx_S0MPMsnQ>