API V1 - Sleeves

Sleeves Endpoint

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

Sleeve Object

Here is the shape of the Sleeve 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 sleeve>
    "ordinal": <ordinal value of the sleeve>
    "topMeasuredDepth": <top measured depth for this sleeve>
    "bottomMeasuredDepth": <bottom measured depth for this sleeve>
    "depthUnit": <unit of measured depth>
    "portSize": <port size measurement of sleeve>
    "portSizeUnit": <port size unit of measurement of sleeve>
    "ballSize": <ball size of sleeve>
    "ballSizeUnit": <ball size unit of sleeve>
    "seatID": <seat size of sleeve>
    "manufacturer": <manufacturer of sleeve>
    "model": <model of sleeve>
}

Here is a fully populated Sleeve object.

{
    "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
    "wellName": "Sample Ball-and-Sleeve",
    "api": "05-123-00000-00-00",
    "stageNumber": 1,
    "name": "Sample Sleeve",
    "ordinal": 1,
    "topMeasuredDepth": 11885,
    "bottomMeasuredDepth": 11999,
    "depthUnit": "feet",
    "portSize": 1,
    "portSizeUnit": "sqinches",
    "ballSize": 1,
    "ballSizeUnit": "inches",
    "seatID": 1,
    "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/sleeves/{JobId}

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

curl https://api.welldatalabs.com/sleeves/b332c113-3397-4379-8ab7-302efc3ae949 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

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

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

curl https://api.welldatalabs.com/sleeves?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/sleeves/b332c113-3397-4379-8ab7-302efc3ae949?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.