POST api/{orgKey}/DispatchOrder/{userKey}/CreateDispatchOrder

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orgKey

integer

Required

userKey

integer

Required

Body Parameters

DispatchOrderModel
NameDescriptionTypeAdditional information
DispatchOrderKey

integer

None.

DispatchOrderLine

integer

None.

Account

string

None.

Sponsor

string

None.

JobNumber

string

None.

JobSite

string

None.

RentalType

string

None.

ActualDispatchDate

date

None.

EstimatedEndDate

date

None.

DispatchOrderNo

integer

None.

DaysOnRent

integer

None.

DispatchOrderStartDate

date

None.

DispatchOrderEndDate

date

None.

EquipmentKey

integer

None.

OrgKey

integer

None.

CustomerName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "dispatchOrderKey": 1,
  "dispatchOrderLine": 2,
  "account": "sample string 3",
  "sponsor": "sample string 4",
  "jobNumber": "sample string 5",
  "jobSite": "sample string 6",
  "rentalType": "sample string 7",
  "actualDispatchDate": "2026-01-29T20:36:57.4301261+00:00",
  "estimatedEndDate": "2026-01-29T20:36:57.4301261+00:00",
  "dispatchOrderNo": 9,
  "daysOnRent": 10,
  "dispatchOrderStartDate": "2026-01-29T20:36:57.4301261+00:00",
  "dispatchOrderEndDate": "2026-01-29T20:36:57.4301261+00:00",
  "equipmentKey": 11,
  "orgKey": 12,
  "customerName": "sample string 13"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PageViewModel
NameDescriptionTypeAdditional information
StatusCode

integer

None.

StatusMessage

string

None.

TotalCount

integer

None.

ModelObject

Object

None.

CurrentDateTime

date

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "statusMessage": "sample string 2",
  "totalCount": 3,
  "modelObject": {},
  "currentDateTime": "2026-01-29T20:36:57.4456798+00:00"
}