POST api/v1/orders

Endpoint that creates a new order. The client is required to send order information and the system will return a new order. The new Id is used for other related operations.

Request Information

URI Parameters

None.

Body Parameters

Order input information

BasicOrderVM
NameDescriptionTypeAdditional information
OrderType

eOrderType

Required
PropertyType

ePropertyType

Required
Address

string

Required
Address2

string

None.
City

string

Required
State

eUSAStateCode

Required
Zip

string

Required
OrganizationCode

string

None.
BatchId

string

None.
ExternalRefId

string

None.
FieldSurveyDate

date

None.
Remarks

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "orderType": 0,
  "propertyType": 1,
  "address": "sample string 1",
  "address2": "sample string 2",
  "city": "sample string 3",
  "state": 0,
  "zip": "sample string 4",
  "organizationCode": "sample string 5",
  "batchId": "sample string 6",
  "externalRefId": "sample string 7",
  "fieldSurveyDate": "2024-11-05T13:05:37.7791624+00:00",
  "remarks": "sample string 9"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A new record with an HTTP 201 (Created), or HTTP 400 (Bad Request) when the request body has invalid values.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.