POST api/v1/orders/withrepairs
Endpoint that creates a new order with repair items. 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
BasicOrderWithRepairsVMName | Description | Type | Additional information |
---|---|---|---|
OrderType | eOrderType |
Required |
|
PropertyType | ePropertyType |
Required |
|
Address | string |
Required |
|
Address2 | string |
None. |
|
City | string |
Required |
|
State | string |
Required |
|
Zip | string |
Required |
|
OrganizationCode | string |
None. |
|
BatchId | string |
None. |
|
ExternalRefId | string |
None. |
|
FieldSurveyDate | date |
None. |
|
Remarks | string |
None. |
|
repairItemsInfo | Collection of BasicRepairItemInformationVM |
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": "sample string 4", "zip": "sample string 5", "organizationCode": "sample string 6", "batchId": "sample string 7", "externalRefId": "sample string 8", "fieldSurveyDate": "2024-12-28T19:22:47.7967378+00:00", "remarks": "sample string 10", "repairItemsInfo": [ { "itemXREF": 1, "description": "sample string 2", "vendorPPU": 3.0, "quantity": 4.0, "comments": "sample string 5", "code": "sample string 6", "itemUM": "sample string 7" }, { "itemXREF": 1, "description": "sample string 2", "vendorPPU": 3.0, "quantity": 4.0, "comments": "sample string 5", "code": "sample string 6", "itemUM": "sample string 7" } ] }
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.
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.