GET OData/DocDownTimes({DocIDDownTime})

Retrieves an entity based on the provided key

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 2b311cad-5a55-4e10-af3a-6d35e83be00e

URI Parameters

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

Sample Uri

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

Body Parameters

None.

Response Information

Success Response

docDownTime

Sample Success

application/json, text/json:

{
  "DocIDDownTime": 1,
  "UserID": "sample string 2",
  "EntityID": 1,
  "EntityTypeID": 1,
  "docDate": "2024-11-13T23:44:25.689736",
  "HrsDown": 1.1,
  "DownTimeCode": 1,
  "OilDown": true,
  "WaterDown": true,
  "GasDown": true,
  "Stamp": "2024-11-13T23:44:25.689736",
  "Notes": "sample string 5",
  "InputByID": "sample string 6",
  "DocSourceCode": 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"
    }
  }
}