POST api/request

The Post handler handles https restful post request The request should look like https://localhost:5001/api/request In test lab we used the port 44361 instead. The JSON request Parameters: { Address1: "1025 INDUSTRIAL PARKWAY", Address2: "APT 4323C", City: "NEWBERG", State: "OR", Zip: "97132" } Ensure that the right IP address is configured in AESRequest.cs

Request Information

URI Parameters

None.

Body Parameters

Address
NameDescriptionTypeAdditional information
Address1

string

None.

Address2

string

None.

City

string

None.

State

string

None.

Zip

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Address1": "sample string 1",
  "Address2": "sample string 2",
  "City": "sample string 3",
  "State": "sample string 4",
  "Zip": "sample string 5"
}

application/xml, text/xml

Sample:
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AESRestServer.Models">
  <Address1>sample string 1</Address1>
  <Address2>sample string 2</Address2>
  <City>sample string 3</City>
  <State>sample string 4</State>
  <Zip>sample string 5</Zip>
</Address>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

json formatted, CASS certified address

Collection of string

Response Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>