API V1 - StageComments

StageComments Endpoint

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

StageComment Object

Here is the shape of the StageComment 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>
    "comment": <comment text>
    "userName": <user name of comment>
}

Here is a fully populated StageComment object.

{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 21,
    "comment": "Stage 21 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 20,
    "comment": "Stage 20 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 19,
    "comment": "Stage 19 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 18,
    "comment": "Stage 18 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 17,
    "comment": "Stage 17 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 16,
    "comment": "Stage 16 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 15,
    "comment": "Stage 15 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 14,
    "comment": "Stage 14 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 13,
    "comment": "Stage 13 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 12,
    "comment": "Stage 12 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 11,
    "comment": "Stage 11 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 10,
    "comment": "Stage 10 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 9,
    "comment": "Stage 9 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 8,
    "comment": "Stage 8 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 7,
    "comment": "Stage 7 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 6,
    "comment": "Stage 6 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 5,
    "comment": "Stage 5 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 4,
    "comment": "Stage 4 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 3,
    "comment": "Stage 3 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 2,
    "comment": "Stage 2 comments are entered into this field.",
    "userName": "Test User"
},
{
    "jobId": "82376c1f-0948-4bf8-a379-3e9c6d692e36",
    "wellName": "Demo Well Q",
    "api": "00-563-12346-00-",
    "stageNumber": 1,
    "comment": "Stage 1 comments are entered into this field.",
    "userName": "Test User"
}

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/stagecomments/{JobId}

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

curl https://api.welldatalabs.com/stagecomments/82376c1f-0948-4bf8-a379-3e9c6d692e36 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

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

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

curl https://api.welldatalabs.com/stagecomments?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/stagecomments/82376c1f-0948-4bf8-a379-3e9c6d692e36?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.