PATCH OData/DocPumpingUnits({DocIDPumpingUnits})

Updates an entity based on the provided values (only provided fields will be updated)

Request Information

Header Parameters

Header	Name	Description	Type	Additional information
Accept	Mime Type	The accept header used to specify the acceptable response mime type	string	Optional
Authorization	Scheme	The authorization method (should always be Basic)	string	Required
Authorization	Security Token	The security token obtained by successfully authenticating a user with the Account API	globally unique identifier	Required

Sample Header

Accept: application/json

Authorization: Basic feb67b91-aecb-4346-93e9-7d09c25de07c

URI Parameters

Name	Description	Type	Additional information
key	The key of the entity to update	integer	Required

Sample Uri

https://apps.fielddirect.com/DataServices/OData/DocPumpingUnits(1)

Body Parameters

The updates to be applied to the entity

docPumpingUnits

Sample Body

application/json, text/json:

{
  "DocIDPumpingUnits": 1,
  "PumpingUnitID": 1,
  "UserID": "sample string 2",
  "docDate": "2024-11-13T23:47:38.1583769",
  "StrokeSpeed": 1.1,
  "StrokeLength": 1.1,
  "CycleOnTime": 1.1,
  "CycleOffTime": 1.1,
  "CyclePumpTime": 1.1,
  "MaxRodStress": 1,
  "MinRodStress": 1,
  "PumpingUnitEff": 1.1,
  "TheoreticalOutput": 1.1,
  "PumpDownTime": 1.1,
  "PumpOffFlag": true,
  "PumpStatusFlag": true,
  "PumpCard1": "sample string 6",
  "PumpCard2": "sample string 7",
  "Quality": "sample string 8",
  "Stamp": "2024-11-13T23:47:38.1583769",
  "Notes": "sample string 10",
  "InputByID": "sample string 11",
  "DocSourceCode": 1,
  "PumpIntakePressure": 1.1,
  "PumpFillage": 1.1,
  "NetStrokeLength": 1.1
}

Response Information

Success Response

docPumpingUnits

Sample Success

application/json, text/json:

{
  "DocIDPumpingUnits": 1,
  "PumpingUnitID": 1,
  "UserID": "sample string 2",
  "docDate": "2024-11-13T23:47:38.1780397",
  "StrokeSpeed": 1.1,
  "StrokeLength": 1.1,
  "CycleOnTime": 1.1,
  "CycleOffTime": 1.1,
  "CyclePumpTime": 1.1,
  "MaxRodStress": 1,
  "MinRodStress": 1,
  "PumpingUnitEff": 1.1,
  "TheoreticalOutput": 1.1,
  "PumpDownTime": 1.1,
  "PumpOffFlag": true,
  "PumpStatusFlag": true,
  "PumpCard1": "sample string 6",
  "PumpCard2": "sample string 7",
  "Quality": "sample string 8",
  "Stamp": "2024-11-13T23:47:38.1780397",
  "Notes": "sample string 10",
  "InputByID": "sample string 11",
  "DocSourceCode": 1,
  "PumpIntakePressure": 1.1,
  "PumpFillage": 1.1,
  "NetStrokeLength": 1.1
}

Error Response

An error response containing the details about a failed api request

ErrorResponse

Sample Error

application/json, text/json:

{
  "error": {
    "batcherror": {
      "operationindex": 1,
      "requestindex": 2
    },
    "code": "UnknownError",
    "innererror": {
      "innererror": {
        "message": {
          "lang": "en-US",
          "value": "sample string 3"
        },
        "type": "sample string 5",
        "trace": "sample string 4"
      },
      "message": {
        "lang": "en-US",
        "value": "sample string 6"
      },
      "type": "sample string 8",
      "trace": "sample string 7"
    },
    "message": {
      "lang": "en-US",
      "value": "sample string 9"
    }
  }
}