Get started

    API Endpoint

        https://api.rocscience.com/
                

The RSLog API provides programatic access to CRUD action for many endpoints and entities.

To use this API, you need to have these features enabled and the correct permissions. Please visit us at Contact Us if you have any questions. For more information about RSLog, view the RSLog Documentation.

Creating a REST Request

REST requests can be used in code, a browser, or command line. Each REST request consists of a base url, an endpoint, headers, and a body. The base url is always the same, https://www.rslogonline.com/. The endpoint is specific to each request. The header is used to perform authentication. The body consist of all data being sent to the API. This documentation will specify each of these elements for all available APIs.

Each REST request must have an HTTP method identified to perform a specific function. These types are display in the table below and must be specified when making each request.

URL STRUCTURE

https://www.rslogonline.com/{endpoint}

HTTP Methods

How To Connect

POST

To connect to the RSLog API and recieve a token, send a post request to the follwing url with the body of the request specified below:
/api/connect/token

BODY

x-www-form-urlencoded

Using the Token

Once you have recieved the token, add it to the header of each API call. See an example header below:

Projects

POST

## Here is an example POST BODY
{
    "title" : "Geographic",
    "contactId" : "10B36C5D-6271-0A48-787B-3A054DA59D0E",
    "projectStatusId" : "62F2F00F-E014-4781-B121-367FE22C3270",
    "unitSystemId" : "FF4D854B-423F-4C53-B5F7-2F22AE87B1D4",
    "coordinateSystemId" : "234E363F-9096-4AFC-A95D-4E791F7C190B",
    "lat" : 32.40939,
    "long": -23.30293
}
    

To create a new project you need to make a POST call to the follwing url:
/api/v1/project

BODY PARAMETERS

GET

To get a project, you need to make a GET call to the following url:
/api/v1/project/{id}

GET ALL Projects

To get all projects, you need to make a GET call to the following url:
/api/v1/projects

GET ALL Boreholes

To get all boreholes from a project, you need to make a GET call to the following url:
/api/v1/project/{id}/boreholes

PUT

To get a stratigraphy you need to make a GET call to the following url:
/api/v1/project/{id}

BODY PARAMETERS

Boreholes

POST

    ## Here is an example POST BODY
    {
        "name" : "API's Borehole",
        "testHoleType" : "0",
        "depth" : 43,
        "projectId" : "635be7fa-0c71-21b4-1628-3a0e79f4115b",
        "boreholeStatusId" : "17C53CE0-036E-40C7-A204-1AE30B0AD158"
    }
        

To create a new borehole you need to make a POST call to the following url:
/api/v1/borehole

BODY PARAMETERS

GET

To get a borehole you need to make a GET call to the following url:
/api/v1/borehole/{id}

PUT

    ## Here is an example PUT BODY
    {
        "name" : "Jim's Borehole",
        "testHoleType" : "0",
        "depth" : 43,
        "projectId" : "635be7fa-0c71-21b4-1628-3a0e79f4115b",
        "boreholeStatusId" : "17C53CE0-036E-40C7-A204-1AE30B0AD158"
    }
        

To modify an existing borehole, you need to make a PUT call to the following url:
/api/v1/borehole/{id}

BODY PARAMETERS

GET ALL Stratigraphies

To get all the stratigraphis from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/stratigraphies

GET ALL Comments

To get all the comments from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/comments

GET ALL Drill Runs

To get all the drill runs from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/drill-runs

GET ALL Boring Details

To get all the boring details from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/boring-details

GET ALL Piezometers

To get all the piezometers from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/piezometers

GET ALL Backfill Details

To get all the backfill details from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/backfill-details

GET ALL Discontinuities

To get all the discontinuities from a borehole, you need to make a GET call to the following url:
/api/v1/borehole/{id}/discontinuities

Stratigraphy

POST

    Stratigraphy POST BODY QUERY Examples:
    (USCS)

    {
        "boreholeId" : "2aa74dd5-63e5-a525-6cf4-3a14cb02a6e3",
        "classificationSystem": "USCS",
        "MajorType" : "25af4bbb-9492-5a28-fe5b-3a0bf543d2dc",
        "GroupName" : "8d5df4a9-7a71-6253-29a2-3a0bf543d2dc",
        "GroupSymbol" : "c24cb143-44f6-ca90-3997-3a0bf543d2d3",
        "SoilSymbolId" : "BC9EA70F-3077-4AB7-B0F0-6E3BF1903556",
        "from" : 11,
        "to": 15,
        "ColorTermId" : "652637AC-888E-4ED5-828C-EFE323F8ABAD",
        "ColorTermCode" : "fbae9348-1e2d-4a69-9ab0-9bd9c8360cf2",
        "JoinerTerm" : 2,
        "JoinerTermCode" : "1f07c4d3-71da-42c9-bb73-557181d30a83",
        "ConsistencyDescriptorId" : "6ef80839-c9ab-4f7a-95bd-512cc1b2868b",
        "MoistureDescriptorId" : "0cb4fed5-666a-48e1-bb9b-1f2174e82e09",
        "StructureId" : "14b379d8-29df-4c26-9f64-1ef28a989046",
        "UnitWeight" : 100.0,
        "LineStyleId" : "2fd627fa-3578-4b37-8771-500bd518107f",
        "ThicknessId" : "c431dfa5-b81e-4b81-9864-9da94caecf71",
        "Color" : "#FFFFFF",
        "FinesPercent" : 90,
        "FinesPlasticityId" : "887f1548-8ceb-4ddd-a2be-37402342f097",
        "FinesDryStrengthId" : "6db3eece-c20d-476a-bf5d-6686ad2094b9",
        "FinesDilatancyId" : "a1b4c5f5-c92b-4a6c-ac65-6ae3bff7bd15",
        "FinesToughnessId" : "63430552-02a5-42ec-8060-d21067bd94be",
        "SandProportionId" : "bfca46c0-a679-4780-9832-2f6377a3ad3e",
        "SandParticleSizeIdsList" : ["3deabc8f-f895-446a-b504-effb7b6c700e","bac12fa8-acd0-4e9c-9434-cc6c650eb7e5"],
        "SandParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "SandCementationId" : "861eeebb-5976-4b02-a5b8-57c400f59c2b",
        "GravelProportionId" : "bfca46c0-a679-4780-9832-2f6377a3ad3e",
        "GravelParticleSizeIdsList" : ["c0d87890-0b28-447b-ac1a-33e2a900a96d","fc5a889e-4dfd-4871-bf8e-823229f0913c"],
        "GravelParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "GravelCementationId" : "861eeebb-5976-4b02-a5b8-57c400f59c2b",
        "GravelParticleShapeId" : "de045a19-48a0-49f0-9f43-0e374021b243",
        "CobblesSoilConstituent" : "Interstitial",
        "CobblesPercent" : 50,
        "CobblesRockTypeId" : "ca5208b5-0ea8-4da1-8ee9-877cd34fad10",
        "CobblesSize" : 5,
        "CobblesParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "CobblesWeatheringId" : "7314ceeb-a18b-4ae4-ad59-ad9a5300ec2f",
        "CobblesParticleShapeId" : "9972dea0-f316-47e7-9a52-baeee317ab85",
        "CobblesHardnessId" : "c479b99c-56ab-4cec-8393-c301b02f6541",
        "BouldersSoilConstituent" : "Predominant",
        "BouldersPercent" : 60,
        "BouldersRockTypeId" : "ca5208b5-0ea8-4da1-8ee9-877cd34fad10",
        "BouldersSize" : 3,
        "BouldersParticleAngularityId" : "eba9b0b1-7b6e-4446-868d-e529aba7ad8a",
        "BouldersWeatheringId" : "533680b0-a91d-44cb-96a9-715380854eca",
        "BouldersParticleShapeId" : "9972dea0-f316-47e7-9a52-baeee317ab85",
        "BouldersHardnessId" : "18e2ffd2-20e3-4156-93ff-a3608c2716b6"
    }



    (ROCK)

    {
        "boreholeId" : "2aa74dd5-63e5-a525-6cf4-3a14cb02a6e3",
        "classificationSystem": "ROCK",
        "RockType" : "Igneous",
        "RockCategory": "5f388b84-ab64-436b-84c9-a20dda1d40c5",
        "RockName" : "Gabbro",
        "NameModifier": "Breccia",
        "from" : 12,
        "to": 15,
        "ColorTermId" : "652637AC-888E-4ED5-828C-EFE323F8ABAD",
        "ColorTermCode" : "fbae9348-1e2d-4a69-9ab0-9bd9c8360cf2",
        "JoinerTerm" : 2,
        "JoinerTermCode" : "1f07c4d3-71da-42c9-bb73-557181d30a83",
        "UnitWeight" : 100.0,
        "LineStyleId" : "2fd627fa-3578-4b37-8771-500bd518107f",
        "ThicknessId" : "c431dfa5-b81e-4b81-9864-9da94caecf71",
        "Color" : "#FFFFFF",
        "BeddingThicknessId" : "d9404616-da1b-4f8e-9183-86c983369d5f",
        "SlakingId" : "5d833822-102a-483a-b397-198d5836b441",
        "FractureDensityId" : "f409bacc-93bf-4f0f-b61c-1fef3304f43d",
        "WeatheringId" : "391ddcef-2e62-4fb0-94b2-9db7ad9ce492",
        "HardnessId" : "8a06aea7-5248-44d9-bf09-6f32df347eea",
        "StrengthId" : "b224d8f3-8182-4bda-915c-3d361bb83b0d"
    }

    (AASHTO)

    {
        "boreholeId" : "7ffe5d5c-5b5b-61c1-7343-3a14459594c9",
        "classificationSystem": "AASHTO",
        "MajorType" : "b488e752-0e11-2b1b-46e6-3a0bf543d2dc",
        "SignificantConstituent" : "3ecfeabd-4f04-3d28-6c6a-3a0bf543d2dc",
        "Characteristics" : "5043695a-10c4-2c93-2d6e-3a0bf543d2dc",
        "GroupSymbol" : "52d9efc8-1b07-c52a-c265-3a0bf543d2dc",
        "from" : 5,
        "to": 8
    }

    (AGS)

    {
        "boreholeId" : "7ffe5d5c-5b5b-61c1-7343-3a14459594c9",
        "classificationSystem": "AGS",
        "MajorType" : "4be481c0-121e-eff2-2b33-3a0bf543d2dc",
        "MaterialDescription" : "44b25e95-7e40-267e-1696-3a0bf543d2dc",
        "from" : 10,
        "to": 12
    }
    

To create a new stratigraphy you need to make a POST call to the following url:
/api/v1/stratigraphy

Note: Stratigraphy inherits the Common Layer Info Dto as well

BODY PARAMETERS

GET

To get a stratigraphy you need to make a GET call to the following url:
/api/v1/stratigraphy/{id}

PUT

    ## PUT body example
    {
        "Symbol": "apple"
    }
                

To modify an existing stratigraphy, make a PUT call to the following url:
/api/v1/stratigraphy/{id}

Note: Stratigraphy inherits the Common Layer Info Dto as well

BODY PARAMETERS

GET ALL INTERIM

To get all interims from a stratigraphy, you need to make a GET call to the following url:
/api/v1/stratigraphy/{id}/interim

GET ALL FRACTURE CONDITION

To get all fracture conditions from a stratigraphy, you need to make a GET call to the following url:
/api/v1/stratigraphy/{id}/fracture-condition

GET ALL DRILLING OBSERVATION

To get all drilling observations from a stratigraphy, you need to make a GET call to the following url:
/api/v1/stratigraphy/{id}/drilling-observation

Interim

POST

    ## Here is an example POST BODY
    {
        "StratigraphyId": "CF37290D-FF4D-BDB3-016A-3A14D4CEC63D",
        "ClassificationSystem": "USCS",
        "Depth": 2.5,
        "Variable": 1,
        "ReferenceId": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6"
    }
        

To create a new interim you need to make a POST call to the following url:
/api/v1/interim

BODY PARAMETERS

GET

To get an interim you need to make a GET call to the following url:
/api/v1/interim/{id}

PUT

    ## PUT BODY example
    {
        "StratigraphyId": "CF37290D-FF4D-BDB3-016A-3A14D4CEC63D",
        "ClassificationSystem": "USCS",
        "Depth": 2.5,
        "Variable": 1,
        "ReferenceId": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6"
    }
        

To modify an existing interim, make a PUT call to the following url:
/api/v1/interim/{id}

BODY PARAMETERS

Interim Details

POST

    ## Here is an example POST BODY
    USCS, Interbedded Layer

    {
        "referenceID" : "B7AFD797-FEEF-0810-BC0A-3A15231A3C60",
        "parentType" : "Soil",
        "childType" : 1,
        "MajorType" : "25af4bbb-9492-5a28-fe5b-3a0bf543d2dc",
        "GroupName" : "8d5df4a9-7a71-6253-29a2-3a0bf543d2dc",
        "GroupSymbol" : "c24cb143-44f6-ca90-3997-3a0bf543d2d3",
        "InterbedJoinerId" : "EA6906FA-F305-48A8-9676-B56B097450E9",
        "ColorTermId" : "652637AC-888E-4ED5-828C-EFE323F8ABAD",
        "ColorTermCode" : "fbae9348-1e2d-4a69-9ab0-9bd9c8360cf2",
        "JoinerTerm" : 2,
        "JoinerTermCode" : "1f07c4d3-71da-42c9-bb73-557181d30a83",
        "ConsistencyDescriptorId" : "6ef80839-c9ab-4f7a-95bd-512cc1b2868b",
        "MoistureDescriptorId" : "0cb4fed5-666a-48e1-bb9b-1f2174e82e09",
        "StructureId" : "14b379d8-29df-4c26-9f64-1ef28a989046",
        "FinesPercent" : 90,
        "FinesPlasticityId" : "887f1548-8ceb-4ddd-a2be-37402342f097",
        "FinesDryStrengthId" : "6db3eece-c20d-476a-bf5d-6686ad2094b9",
        "FinesDilatancyId" : "a1b4c5f5-c92b-4a6c-ac65-6ae3bff7bd15",
        "FinesToughnessId" : "63430552-02a5-42ec-8060-d21067bd94be",
        "SandProportionId" : "bfca46c0-a679-4780-9832-2f6377a3ad3e",
        "SandParticleSizeIdsList" : ["3deabc8f-f895-446a-b504-effb7b6c700e","bac12fa8-acd0-4e9c-9434-cc6c650eb7e5"],
        "SandParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "SandCementationId" : "861eeebb-5976-4b02-a5b8-57c400f59c2b",
        "GravelProportionId" : "bfca46c0-a679-4780-9832-2f6377a3ad3e",
        "GravelParticleSizeIdsList" : ["c0d87890-0b28-447b-ac1a-33e2a900a96d","fc5a889e-4dfd-4871-bf8e-823229f0913c"],
        "GravelParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "GravelCementationId" : "861eeebb-5976-4b02-a5b8-57c400f59c2b",
        "GravelParticleShapeId" : "de045a19-48a0-49f0-9f43-0e374021b243",
        "CobblesPercent" : 50,
        "CobblesRockTypeId" : "ca5208b5-0ea8-4da1-8ee9-877cd34fad10",
        "CobblesSize" : 5,
        "CobblesParticleAngularityId" : "95e7c972-9eaf-4572-82d2-3c490f969ed1",
        "CobblesWeatheringId" : "7314ceeb-a18b-4ae4-ad59-ad9a5300ec2f",
        "CobblesParticleShapeId" : "9972dea0-f316-47e7-9a52-baeee317ab85",
        "CobblesHardnessId" : "c479b99c-56ab-4cec-8393-c301b02f6541",
        "BouldersPercent" : 60,
        "BouldersRockTypeId" : "ca5208b5-0ea8-4da1-8ee9-877cd34fad10",
        "BouldersSize" : 3,
        "BouldersParticleAngularityId" : "eba9b0b1-7b6e-4446-868d-e529aba7ad8a",
        "BouldersWeatheringId" : "533680b0-a91d-44cb-96a9-715380854eca",
        "BouldersParticleShapeId" : "9972dea0-f316-47e7-9a52-baeee317ab85",
        "BouldersHardnessId" : "18e2ffd2-20e3-4156-93ff-a3608c2716b6"
    }

    ROCK, Interbedded Layer

    {
        "referenceID" : "FB6D3D49-A984-63A7-3E5E-3A1523763F16",
        "parentType" : "Rock",
        "childType" : 1,
        "InterbedJoinerId" : "EA6906FA-F305-48A8-9676-B56B097450E9",
        "RockType" : "Igneous",
        "RockCategory": "5f388b84-ab64-436b-84c9-a20dda1d40c5",
        "RockName" : "Gabbro",
        "NameModifier": "Breccia",
        "ColorTermId" : "652637AC-888E-4ED5-828C-EFE323F8ABAD",
        "ColorTermCode" : "fbae9348-1e2d-4a69-9ab0-9bd9c8360cf2",
        "JoinerTerm" : 2,
        "JoinerTermCode" : "1f07c4d3-71da-42c9-bb73-557181d30a83",
        "BeddingThicknessId" : "d9404616-da1b-4f8e-9183-86c983369d5f",
        "SlakingId" : "5d833822-102a-483a-b397-198d5836b441",
        "FractureDensityId" : "f409bacc-93bf-4f0f-b61c-1fef3304f43d",
        "WeatheringId" : "391ddcef-2e62-4fb0-94b2-9db7ad9ce492",
        "HardnessId" : "8a06aea7-5248-44d9-bf09-6f32df347eea",
        "StrengthId" : "b224d8f3-8182-4bda-915c-3d361bb83b0"
    }
        

To create a new interim detail you need to make a POST call to the following url :
/api/v1/interim-detail

Note: Interim Details inherits the Common Layer Info Dto as well

BODY PARAMETERS

GET

To get an interim detail you need to make a GET call to the following url :
/api/v1/interim-detail/{id}

PUT

To modify an existing interim detail, make a PUT call to the following url :
/api/v1/interim-detail/{id}

Note: Interim Details inherits the Common Layer Info Dto as well

BODY PARAMETERS

Plug Types

POST

    ## Here is an example POST BODY
    {
        "Descriptor": "apple",
        "Symbol": "apples"
    }
    

To create a new plug type you need to make a POST call to the following url:
/api/v1/plug-type

    ## Result example :

    {
        "descriptor": "apple",
        "symbol": "apples",
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-10-04T15:29:36.8212518-04:00",
        "creatorId": null,
        "id": "c1f08383-285a-46a3-5eca-3a156b2f2814"
    }
    

BODY PARAMETERS

GET

To get a plug type you need to make a GET call to the following url:
/api/v1/plug-type/{id}

GETALL

To get all plug types you need to make a GET call to the following url:
/api/v1/plug-types

PUT

    ## PUT body example
    {
        "Symbol": "apple"
    }
                

To modify an existing plug type, make a PUT call to the following url:
/api/v1/plug-type/{id}

BODY PARAMETERS

Piezometer Types

POST

    ## Here is an example POST BODY
    {
        "Descriptor": "apple",
        "Symbol": "apples"
    }
    

To create a new piezometer type you need to make a POST call to the following url:
/api/v1/piezometer-type

BODY PARAMETERS

GET

To get a piezometer type you need to make a GET call to the following url:
/api/v1/piezometer-type/{id}

GETALL

To get all piezometer types you need to make a GET call to the following url:
/api/v1/piezometer-types

PUT

    ## PUT BODY example
    {
        "Symbol": "apple"
    }
                

To modify an existing piezometer type, make a PUT call to the following url:
/api/v1/piezometer-type/{id}

BODY PARAMETERS

Boring Details

POST

    ## Here is an example POST BODY
    {
        "BoreholeId": "CF37290D-FF4D-BDB3-016A-3A14D4CEC63D",
        "From": 1.0,
        "To": 3.0,
        "DrillRig": "Example Drill Rig",
        "DrillMethodId": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6",
        "AGSDrillMethodId": "B2C3D4E5-F6G7-H8I9-J0K1-L2M3N4O5P6Q7",
        "RigTypeId": "C3D4E5F6-G7H8-I9J0-K1L2-M3N4O5P6Q7R8",
        "BitTypeId": "D4E5F6G7-H8I9-J0K1-L2M3-N4O5P6Q7R8S9",
        "HoleCasingTypeId": "E5F6G7H8-I9J0-K1L2-M3N4-O5P6Q7R8S9T0",
        "TenantId": "F6G7H8I9-J0K1-L2M3-N4O5-P6Q7R8S9T0U1",
        "DrillMethod": "Example Drill Method",
        "DrillMethodTitle": "Example Drill Method Title",
        "HoleDiameter": 10.5,
        "CasingDiameter": 8.5,
        "DrillRod": "Example Drill Rod",
        "DrillBit": "Example Drill Bit",
        "Notes": "Example notes for boring method",
        "AGSBackfillId": "G7H8I9J0-K1L2-M3N4-O5P6-Q7R8S9T0U1V2",
        "BackFillCode": "BF001",
        "InstrumentInstalle": false,
        "Date": "2024-10-08 14:30",
        "Time": "14:30:00"
    }
    

To create a new boring detail you need to make a POST call to the following url:
/api/v1/boring-detail

    ## Result example :
    {
        "boreholeId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        ...
    }
    

BODY PARAMETERS

GET

To get a boring detail you need to make a GET call to the following url:
/api/v1/boring-detail/{id}

PUT

    ## PUT BODY example
    {
        "From": 1.5,
        "To": 3.5,
        "DrillRig":"Updated Drill Rig",
        "HoleDiameter" :11.0,
        "CasingDiameter" :9.0,
        "Notes":"Updated notes for boring detail"
    }
    

To modify an existing boring detail, make a PUT call to the following url:
/api/v1/boring-detail/{id}

BODY PARAMETERS

Backfill Details

POST

    ## Here is an example POST BODY
    {
        "To": 2.0,
        "From": 1.0,
        "BoreholeId": "675145F2-2F6A-4CFE-98BE-097AEBA1EFEF"
    }
    

To create a new backfill detail you need to make a POST call to the following url:
/api/v1/backfill-details

    ## Result example :
    {
        "from": 1,
        "to": 2,
        "boreholeId": "675145f2-2f6a-4cfe-98be-097aeba1efef",
        "agsBackfillId": null,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-19T13:47:43.4073327-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "a780645b-a1a9-4b6b-cd37-3a151d927b8e"
    }
    

BODY PARAMETERS

GET

To get a backfill detail you need to make a GET call to the following url:
/api/v1/backfill-details/{id}

PUT

    ## PUT BODY example
    {
        "From": 3.0
        "To": 5.0
    }
                    

To modify an existing backfill detail, make a PUT call to the following url:
/api/v1/backfill-details/{id}

BODY PARAMETERS

Samples

POST

    ## Here is an example POST BODY
    {
        "boreholeId" : "C70E67B3-DA65-5C47-5531-3A13BB459FAE",
        "sampleTypeId" : "B737A4E3-747D-46A1-BA57-17320FFEC675",
        "depth": 50,
        "to": 100,
        "colorTermId": "AA4CF1B4-B07B-4CE4-A422-363DB9E13B98",
        "joinerTerm": 1,
        "colorTermCode": "4BFC4362-60B8-4365-8D17-01D94BF25707",
        "joinerTermCode": "99413134-1C99-44CF-B6CB-046889C11046"
    }
    

To create a new sample you need to make a POST call to the following url:
/api/v1/sample

BODY PARAMETERS

GET

To get a sample you need to make a GET call to the following url:
/api/v1/sample/{id}

PUT

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

To modify an existing sample, make a PUT call to the following url:
/api/v1/sample/{id}

BODY PARAMETERS

Comments

POST

    ## Here is an example POST BODY
    {
        "BoreholeId": "60FFD87C-F87D-4DCC-89A2-653205CDB0A1",
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
    

To create a new comment you need to make a POST call to the following url:
/api/v1/comment

BODY PARAMETERS

GET

To get a comment you need to make a GET call to the following url:
/api/v1/comment/{id}

PUT

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

To modify an existing comment, make a PUT call to the following url:
/api/v1/comment/{id}

BODY PARAMETERS

Fracture Conditions

POST

    ## Here is an example POST BODY
    {
        "BoreholeId": "60FFD87C-F87D-4DCC-89A2-653205CDB0A1",
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
    

To create a new fracture condition you need to make a POST call to the following url:
/api/v1/fracture-condition

    ## Result example :

    {
        "from": 3,
        "to": 1,
        "nestedPiezometerId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        "pipeTypeId": null,
        "agsPipeTypeId": null,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-16T09:45:26.0161668-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "ab24c234-6f94-9971-e277-3a150d4194bc"
    }
    

BODY PARAMETERS

GET

To get a fracture condition you need to make a GET call to the following url:
/api/v1/fracture-condition/{id}

PUT

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

To modify an existing fracture condition, make a PUT call to the following url:
/api/v1/fracture-condition/{id}

BODY PARAMETERS

Drilling Observations

POST

    ## Here is an example POST BODY
    {
        "BoreholeId": "60FFD87C-F87D-4DCC-89A2-653205CDB0A1",
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
    

To create a new drilling observation you need to make a POST call to the following url:
/api/v1/drilling-observation

    ## Result example :

    {
        "from": 3,
        "to": 1,
        "nestedPiezometerId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        "pipeTypeId": null,
        "agsPipeTypeId": null,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-16T09:45:26.0161668-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "ab24c234-6f94-9971-e277-3a150d4194bc"
    }
    

BODY PARAMETERS

GET

To get a drilling observation you need to make a GET call to the following url:
/api/v1/drilling-observation/{id}

PUT

To modify an existing drilling observation, make a PUT call to the following url:
/api/v1/drilling-observation/{id}

BODY PARAMETERS

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

Drill Runs

POST

    ## Here is an example POST BODY
    {
        "BoreholeId": "60FFD87C-F87D-4DCC-89A2-653205CDB0A1",
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
    

To create a new drill run you need to make a POST call to the following url:
/api/v1/drill-run

    ## Result example :

    {
        "from": 3,
        "to": 1,
        "nestedPiezometerId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        "pipeTypeId": null,
        "agsPipeTypeId": null,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-16T09:45:26.0161668-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "ab24c234-6f94-9971-e277-3a150d4194bc"
    }
    

BODY PARAMETERS

GET

To get a drill run you need to make a GET call to the following url:
/api/v1/drill-run/{id}

PUT

To modify an existing drill run, make a PUT call to the following url:
/api/v1/drill-run/{id}

BODY PARAMETERS

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

Discontinuities

POST

    ## Here is an example POST BODY
    {
        "boreholeId" : "7ffe5d5c-5b5b-61c1-7343-3a14459594c9",
        "depth": 0,
        "alpha": 5,
        "beta": 2,
        "joinTypeId": "A1C67532-90CD-449F-AD25-BFB8D1F0BE59",
        "shapeId": "ABE2E317-9567-4FC6-8D06-D37787053898",
        "roughnessId": "5D3DD1F7-A1A0-4302-850C-7361C3F0443B",
        "infillTypeId": "3E4CDF32-39DE-4D2F-A015-44D749993807",
        "infillCharacterId": "CA8F37B7-CA1B-4BC9-85D7-16DC2DB735CD",
        "infillThicknessId": "C13CEF8A-52B6-4840-9FE5-D6077A7C1A88"
    }
    

To create a new discontinuity you need to make a POST call to the following url:
/api/v1/discontinuity

BODY PARAMETERS

GET

To get a discontinuity you need to make a GET call to the following url:
/api/v1/discontinuity/{id}

PUT

To modify an existing discontinuity, make a PUT call to the following url:
/api/v1/discontinuity/{id}

BODY PARAMETERS

    ## PUT BODY example
    {
        "SampleTypeId: "bfe38763-863e-486a-91a8-aece9c79d693",
        "Depth": 5.0
    }
                    

Groundwater Measurement

POST

    ## Here is an example POST BODY
    {
        "NestedPiezometerId": "CF37290D-FF4D-BDB3-016A-3A14D4CEC63D",
        "Depth": 1,
        "WaterLevelPresent": true,
        "Date": "2024-09-17T10:30:00Z"
    }
    

To create a new groundwater measurement you need to make a POST call to the following url:
/api/v1/groundwater-measurement

    ## Result example :
    {
        "date": "2024-09-17T10:30:00Z",
        "dateString": null,
        "time": null,
        "depth": 1,
        "weatherCondition": null,
        "nestedPiezometerId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        "boreholeId": "00000000-0000-0000-0000-000000000000",
        "borehole": null,
        "waterLevelPresent": true,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-18T11:58:44.5998326-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "ebfafebf-b590-c676-5747-3a1518085956"
    }
    

BODY PARAMETERS

GET

To get a groundwater measurement you need to make a GET call to the following url:
/api/v1/groundwater-measurement/{id}

PUT

    ## PUT BODY example
    {
        "Depth": 1,
        "waterLevelPresent": true,
        "Date": "2024-09-17T10:30:00Z"
    }
                    

To modify an existing backfill detail, make a PUT call to the following url:
/api/v1/groundwater-measurement/{id}

BODY PARAMETERS

Pipe Segments

POST

    ## Here is an example POST BODY
    {
        "From": 1.0,
        "To": 3.0,
        "NestedPiezometerId": "CF37290D-FF4D-BDB3-016A-3A14D4CEC63D"
    }
    

To create a new pipe segment you need to make a POST call to the following url:
/api/v1/pipe-segment

    ## Result example :

    {
        "from": 3,
        "to": 1,
        "nestedPiezometerId": "cf37290d-ff4d-bdb3-016a-3a14d4cec63d",
        "pipeTypeId": null,
        "agsPipeTypeId": null,
        "lastModificationTime": null,
        "lastModifierId": null,
        "creationTime": "2024-09-16T09:45:26.0161668-04:00",
        "creatorId": "bf3b8e7e-8bb9-6d1a-d4eb-3a019a190b58",
        "id": "ab24c234-6f94-9971-e277-3a150d4194bc"
    }
    

BODY PARAMETERS

GET

To get a pipe segment you need to make a GET call to the following url:
/api/v1/pipe-segment/{id}

PUT

    ## PUT BODY example
    {
        "From": 3.0
        "To": 5.0
    }
                    

To modify an existing pipe segment, make a PUT call to the following url:
/api/v1/pipe-segment/{id}

BODY PARAMETERS

Piezometers

POST

    # Here is a POST example
    {
      "piezometer": {
        "BoreholeId": "675145F2-2F6A-4CFE-98BE-097AEBA1EFEF"
      },
      "pipeSegmentList": [
        {
            "From": 1.0,
            "To": 3.0
        },
        {
            "From": 3.0,
            "To": 5.0
        }
      ],
      "groundwaterList": [
        {
            "WaterLevelPresent": true,
            "Date": "2024-09-17T10:30:00Z"
        }
      ]
    }
                    

To create a new piezometer you need to make a POST call to the following url:
/api/v1/piezometer

    Result example :

    {

    }
                    

BODY PARAMETERS

Note: For the POST request, the input data has 3 components: piezometer, pipeSegmentList, groundwaterList.

Piezometer Object

PipeSegmentList:

A list of pipe-segments, for reference Pipe Segments

GroundwaterList:

A list of groundwater measurements, for reference Groundwater Measurements

GET

To get a piezometer you need to make a GET call to the following url:
/api/v1/piezometer/{id}

PUT

    ## PUT BODY example
    {
        "Depth": 1,
        "waterLevelPresent": true,
        "Date": "2024-09-17T10:30:00Z"
    }
                    

To modify an existing piezometer, make a PUT call to the following url:
/api/v1/piezometer/{id}

Note: For the PUT request, the input data just has the piezometer component.

Piezometer Object

PipeSegmentList:

A list of pipe-segments, for reference Pipe Segments

GroundwaterList:

A list of groundwater measurements, for reference Groundwater Measurements

GET Pipe Segments

To get the pipe segments from a piezometer, make a GET requrest to:
/api/v1/piezometer/{id}/pipe-segments

GET Groundwater Measurements

To get the groundwater measurements from a piezometer, make a GET requrest to:
/api/v1/piezometer/{id}/groundwater-measurements

GUID Get Endpoints

Below is a list of endpoints for getting the GUIDs used in above API calls