API V1 - Plugs

Plugs Endpoint

https://api.welldatalabs.com/plugs/{JobId}

Plug Object

Here is the shape of the Plug object.

{
    "jobId": <Well Data Labs unique id for this job>
    "wellName": <well name for this job>
    "api": <api number for this job>
    "stageNumber": <stage number for this job>
    "name": <name of the plug>
    "ordinal": <ordinal value of the plug>
    "topMeasuredDepth": <top measured depth for this plug>
    "bottomMeasuredDepth": <bottom measured depth for this plug>
    "depthUnit": <unit of measured depth>
    "diameter": <diameter measurement for plug>
    "diameterUnit": <diameter unit of measurement for plug>
    "manufacturer": <manufacturer of plug>
    "model": <model of plug>
}

Here is a fully populated Plug object.

{
    "jobId": "6559af2b-5e0f-4765-8c2d-10eeb9150e45",
    "wellName": "Sample Plug-and-Perf",
    "api": "00-000-00000-00-01",
    "stageNumber": 1,
    "name": "Test Plug",
    "ordinal": 1,
    "topMeasuredDepth": null,
    "bottomMeasuredDepth": null,
    "depthUnit": null,
    "diameter": 1.25,
    "diameterUnit": "inches",
    "manufacturer": "Test Manufacturer",
    "model": "Test Model"
}

HTTP Response Status Codes

Status Code Description
200 Successful request and data was returned in the body
400 JobId not valid or missing.
404 No results found. Note that the endpoint was found, we just didn't find any data matching the criteria.
500 Unexpected error

GET https://api.welldatalabs.com/plugs/{JobId}

A GET request that includes JobId will return an array of Plug objects that match the given JobId.

curl https://api.welldatalabs.com/plugs/6559af2b-5e0f-4765-8c2d-10eeb9150e45 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

GET https://api.welldatalabs.com/plugs?fromStageNumber={number}&toStageNumber={number}

A GET request to the base endpoint with optional fromStageNumber and toStageNumber parameters will return an array of Plug objects that match the given stage numbers.

curl https://api.welldatalabs.com/plugs?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/plugs/6559af2b-5e0f-4765-8c2d-10eeb9150e45?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Stage Number Parameters

Parameter Description
fromStageNumber={number} Returns results for all stages greater than or equal to this parameter value.
toStageNumber={number} Returns results for all stages less than or equal to this parameter value.
fromStageNumber={number}&toStageNumber={number} Returns results for all stages between and including the stages fromStageNumber and toStageNumber.