API Reference for Roustabout Software System Adminstration
To access our Invoicing API, contact us so that we can provide you with the necessary credentials and API URL endpoints.
All API calls are POST request to the endpoint URL, with JSON data returned.
Using the System Admin API to retrieve data
Action: get_all
Vaules Passed: api_key, action, admin_table
admin_table accepted values: (company | leases | asset_types | assets |, employee | invoice_status | jobtypes | jobtype_descriptions | pusher | yards )
Return: Notice, Result (array)
Below are a few examples with return data.
Company Table
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=company
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "314",
"name": "Ada Energy"
},
{
"id": "315",
"name": "Alpha Operating, LLC"
},
{
"id": "316",
"name": "Bulldog Production"
},
{
"id": "317",
"name": "PetroFind"
},
{
"id": "318",
"name": "Red Mountain"
}
]
}Assets
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=assets
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "2294",
"name": "Type M - 2 3\/8\"",
"asset_type": "Swab Cups",
"asset_type_id": "517"
},
{
"id": "2297",
"name": "1 Man Crew + Truck",
"asset_type": "Roustabout Crews",
"asset_type_id": "518"
},
{
"id": "2298",
"name": "2 Man Crew + Truck",
"asset_type": "Roustabout Crews",
"asset_type_id": "518"
},
{
"id": "2299",
"name": "3 Man Crew + Truck",
"asset_type": "Roustabout Crews",
"asset_type_id": "518"
},
{
"id": "2300",
"name": "Rig + 6 Man Crew - Daily",
"asset_type": "Rig Crews",
"asset_type_id": "519"
}
]
}Job Type Descriptions
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=jobtype_descriptions
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "371",
"jobtype": "Wireline Truck",
"description": "ESP-Pump Swap",
"jobtype_id": "94"
},
{
"id": "373",
"jobtype": "Wireline Truck",
"description": "Swab",
"jobtype_id": "94"
},
{
"id": "374",
"jobtype": "Roustabout Services",
"description": "General Labor",
"jobtype_id": "95"
},
{
"id": "375",
"jobtype": "Roustabout Services",
"description": "New Lease Pad",
"jobtype_id": "95"
}
]
}Yards Table
Example: {API URL}?api_key={APIKEY}&action=get_all&admin_table=yards
Example Returned Data
{
"Notice": "Success!",
"Result": [
{
"id": "31",
"name": "Ada Yard"
},
{
"id": "32",
"name": "El Reno Yard"
}
]
}