POST api/um/v1/workorder/complete/{workOrderNumber}

Completes a work order with WorkOrderResult object passed in Post request body.

Request Information

Parameters

Name	Description	Additional information
workOrderNumber	Work order number to complete.	Define this parameter in the request URI.
workOrderResult	Work order result object.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "WorkOrderNumber": "sample string 1",
  "WorkOrderType": "sample string 2",
  "MeterNumber": "sample string 3",
  "CompletedDate": "2025-05-12T04:37:16.5929708-05:00",
  "CompletedByCode": "sample string 5",
  "Canceled": true,
  "ResultCode": "sample string 6",
  "CompletionComments": "sample string 7",
  "WorkOrderReferenceId": "sample string 8",
  "ReadDate": "2025-05-12T04:37:16.5929708-05:00",
  "ReadType": "sample string 9",
  "Measurements": [
    {
      "MeasurementType": "sample string 1",
      "Reading": "sample string 2"
    },
    {
      "MeasurementType": "sample string 1",
      "Reading": "sample string 2"
    },
    {
      "MeasurementType": "sample string 1",
      "Reading": "sample string 2"
    }
  ],
  "NewMeter": {
    "MeterNumber": "sample string 1",
    "MeterType": "sample string 2",
    "NewRoute": "sample string 3",
    "NewSequence": "sample string 4",
    "NewMeterRates": [
      {
        "Rate": "sample string 1"
      },
      {
        "Rate": "sample string 1"
      },
      {
        "Rate": "sample string 1"
      }
    ],
    "NewMeterMeasurements": [
      {
        "MeterMeasurementType": "sample string 1",
        "MeterInitialSetting": 2
      },
      {
        "MeterMeasurementType": "sample string 1",
        "MeterInitialSetting": 2
      },
      {
        "MeterMeasurementType": "sample string 1",
        "MeterInitialSetting": 2
      }
    ],
    "NewMeterServices": [
      {
        "ServiceType": "sample string 1"
      },
      {
        "ServiceType": "sample string 1"
      },
      {
        "ServiceType": "sample string 1"
      }
    ],
    "RemoteNumbers": "sample string 5",
    "AmrCode": "sample string 6",
    "AmrNumber": "sample string 7",
    "AmrTestCircle": "sample string 8",
    "CommuncationIdentifier": "sample string 9"
  }
}

application/xml, text/xml

Sample:

<WorkOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewWorld.Logos.WebApi.Models.UM.WorkOrder">
  <Canceled>true</Canceled>
  <CompletedByCode>sample string 5</CompletedByCode>
  <CompletedDate>2025-05-12T04:37:16.5929708-05:00</CompletedDate>
  <CompletionComments>sample string 7</CompletionComments>
  <Measurements xmlns:d2p1="http://schemas.datacontract.org/2004/07/NewWorld.Logos.UM.Models">
    <d2p1:MeasurementResult>
      <d2p1:MeasurementType>sample string 1</d2p1:MeasurementType>
      <d2p1:Reading>sample string 2</d2p1:Reading>
    </d2p1:MeasurementResult>
    <d2p1:MeasurementResult>
      <d2p1:MeasurementType>sample string 1</d2p1:MeasurementType>
      <d2p1:Reading>sample string 2</d2p1:Reading>
    </d2p1:MeasurementResult>
    <d2p1:MeasurementResult>
      <d2p1:MeasurementType>sample string 1</d2p1:MeasurementType>
      <d2p1:Reading>sample string 2</d2p1:Reading>
    </d2p1:MeasurementResult>
  </Measurements>
  <MeterNumber>sample string 3</MeterNumber>
  <NewMeter xmlns:d2p1="http://schemas.datacontract.org/2004/07/NewWorld.Logos.UM.Models">
    <d2p1:AmrCode>sample string 6</d2p1:AmrCode>
    <d2p1:AmrNumber>sample string 7</d2p1:AmrNumber>
    <d2p1:AmrTestCircle>sample string 8</d2p1:AmrTestCircle>
    <d2p1:CommuncationIdentifier>sample string 9</d2p1:CommuncationIdentifier>
    <d2p1:MeterNumber>sample string 1</d2p1:MeterNumber>
    <d2p1:MeterType>sample string 2</d2p1:MeterType>
    <d2p1:NewMeterMeasurements>
      <d2p1:NewMeterMeasurement>
        <d2p1:MeterInitialSetting>2</d2p1:MeterInitialSetting>
        <d2p1:MeterMeasurementType>sample string 1</d2p1:MeterMeasurementType>
      </d2p1:NewMeterMeasurement>
      <d2p1:NewMeterMeasurement>
        <d2p1:MeterInitialSetting>2</d2p1:MeterInitialSetting>
        <d2p1:MeterMeasurementType>sample string 1</d2p1:MeterMeasurementType>
      </d2p1:NewMeterMeasurement>
      <d2p1:NewMeterMeasurement>
        <d2p1:MeterInitialSetting>2</d2p1:MeterInitialSetting>
        <d2p1:MeterMeasurementType>sample string 1</d2p1:MeterMeasurementType>
      </d2p1:NewMeterMeasurement>
    </d2p1:NewMeterMeasurements>
    <d2p1:NewMeterRates>
      <d2p1:NewMeterRate>
        <d2p1:Rate>sample string 1</d2p1:Rate>
      </d2p1:NewMeterRate>
      <d2p1:NewMeterRate>
        <d2p1:Rate>sample string 1</d2p1:Rate>
      </d2p1:NewMeterRate>
      <d2p1:NewMeterRate>
        <d2p1:Rate>sample string 1</d2p1:Rate>
      </d2p1:NewMeterRate>
    </d2p1:NewMeterRates>
    <d2p1:NewMeterServices>
      <d2p1:NewMeterService>
        <d2p1:ServiceType>sample string 1</d2p1:ServiceType>
      </d2p1:NewMeterService>
      <d2p1:NewMeterService>
        <d2p1:ServiceType>sample string 1</d2p1:ServiceType>
      </d2p1:NewMeterService>
      <d2p1:NewMeterService>
        <d2p1:ServiceType>sample string 1</d2p1:ServiceType>
      </d2p1:NewMeterService>
    </d2p1:NewMeterServices>
    <d2p1:NewRoute>sample string 3</d2p1:NewRoute>
    <d2p1:NewSequence>sample string 4</d2p1:NewSequence>
    <d2p1:RemoteNumbers>sample string 5</d2p1:RemoteNumbers>
  </NewMeter>
  <ReadDate>2025-05-12T04:37:16.5929708-05:00</ReadDate>
  <ReadType>sample string 9</ReadType>
  <ResultCode>sample string 6</ResultCode>
  <WorkOrderNumber>sample string 1</WorkOrderNumber>
  <WorkOrderReferenceId>sample string 8</WorkOrderReferenceId>
  <WorkOrderType>sample string 2</WorkOrderType>
</WorkOrderResult>