GET WellPurposes/ByEffectiveDate?assetId={assetId}&wellPurposeTypeId={wellPurposeTypeId}&beginDate={beginDate}&endDate={endDate}

Retrieves well purposes for the given parameters. All parameters are optional.
Request Information

URI Parameters

Name	Description	Type	Additional information
assetId	Id of the asset	globally unique identifier	None.
wellPurposeTypeId	Id of the well purpose type	globally unique identifier	None.
beginDate	Beginning effective date of the well purposes to retrieve	date	None.
endDate	Ending effective date of the well purposes to retrieve	date	None.
Body Parameters

None.
Response Information

Resource Description

On success, a list of well purposes.
Name	Type	Additional information
Data	Collection of WellPurpose	None.
Total	integer	None.
Message	string	None.
Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "WellPurposeId": "b3e6d55b-bd94-49d9-8daa-c10de80fc9ab",
      "Asset": {
        "AssetId": "9572a610-d17e-4388-a2ef-9227bb80287f",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "AssetGroup": {
          "AssetGroupId": "43b5cfc8-b9e4-4f42-9ec4-580bd5a8b2f3",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
          "MeasurementValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "2435fb9e-1243-4194-9232-568af8091129",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "ParentAsset": null,
        "Location": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "State": {
          "StateId": "cda37df2-6514-4622-bb7b-ceac1d981fce",
          "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
          "StateType": {
            "StateTypeId": "36b314de-c5d5-400d-98f2-9a79b0df98d6",
            "Name": "sample string 1",
            "IsOperational": true,
            "AssetType": {
              "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
              "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
              "LastModifiedUser": "sample string 8"
            },
            "SourceSystemId": "sample string 3",
            "CompanyId": "2b1dd63b-f782-4ad3-93f5-61ed523ff5e2",
            "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "SourceSystemId": "sample string 1",
          "CompanyId": "bf01de4c-be0d-4188-9af8-83de5fbc862a",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 3",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 4"
        },
        "Status": {
          "StatusId": "c8fb0fa4-cab5-44fa-bcf2-8504496d5a87",
          "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
          "StatusType": {
            "StatusTypeId": "4cf71afb-5cf3-4bb3-a89a-093f6d844881",
            "Name": "sample string 1",
            "IsProducing": true,
            "IsInjecting": true,
            "AssetType": {
              "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
              "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
              "LastModifiedUser": "sample string 8"
            },
            "SourceSystemId": "sample string 4",
            "CompanyId": "2c1bd485-0b46-4fab-a2ff-a6a7e346d4ed",
            "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
            "CreateUser": "sample string 6",
            "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
            "LastModifiedUser": "sample string 7"
          },
          "SourceSystemId": "sample string 1",
          "CompanyId": "5ad29725-d19a-4d69-b9da-759443d8425d",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 3",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 4"
        },
        "FormValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
        "MeasurementValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "f0b9a8c1-b65c-4e29-8627-e3018a765713",
        "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "69ba89ee-1ec9-4606-819c-6dfab42d0f09",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "b2ebc3fe-6390-43b0-b66c-85bf3fa154d7",
        "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "2b3fe76b-315d-492f-999b-66f5912b9813",
      "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
      "LastModifiedUser": "sample string 4"
    },
    {
      "WellPurposeId": "b3e6d55b-bd94-49d9-8daa-c10de80fc9ab",
      "Asset": {
        "AssetId": "9572a610-d17e-4388-a2ef-9227bb80287f",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "AssetGroup": {
          "AssetGroupId": "43b5cfc8-b9e4-4f42-9ec4-580bd5a8b2f3",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
          "MeasurementValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "2435fb9e-1243-4194-9232-568af8091129",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "ParentAsset": null,
        "Location": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "State": {
          "StateId": "cda37df2-6514-4622-bb7b-ceac1d981fce",
          "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
          "StateType": {
            "StateTypeId": "36b314de-c5d5-400d-98f2-9a79b0df98d6",
            "Name": "sample string 1",
            "IsOperational": true,
            "AssetType": {
              "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
              "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
              "LastModifiedUser": "sample string 8"
            },
            "SourceSystemId": "sample string 3",
            "CompanyId": "2b1dd63b-f782-4ad3-93f5-61ed523ff5e2",
            "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
            "LastModifiedUser": "sample string 6"
          },
          "SourceSystemId": "sample string 1",
          "CompanyId": "bf01de4c-be0d-4188-9af8-83de5fbc862a",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 3",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 4"
        },
        "Status": {
          "StatusId": "c8fb0fa4-cab5-44fa-bcf2-8504496d5a87",
          "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
          "StatusType": {
            "StatusTypeId": "4cf71afb-5cf3-4bb3-a89a-093f6d844881",
            "Name": "sample string 1",
            "IsProducing": true,
            "IsInjecting": true,
            "AssetType": {
              "AssetTypeId": "3dd1ee0c-c4f1-414c-ac23-b5986dc61203",
              "Name": "sample string 1",
              "Description": "sample string 2",
              "IsWell": true,
              "DisplayColor": "sample string 4",
              "SourceSystemId": "sample string 5",
              "CompanyId": "9fed13c7-8345-4c33-bb5e-2d4c92500cdf",
              "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
              "CreateUser": "sample string 7",
              "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
              "LastModifiedUser": "sample string 8"
            },
            "SourceSystemId": "sample string 4",
            "CompanyId": "2c1bd485-0b46-4fab-a2ff-a6a7e346d4ed",
            "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
            "CreateUser": "sample string 6",
            "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
            "LastModifiedUser": "sample string 7"
          },
          "SourceSystemId": "sample string 1",
          "CompanyId": "5ad29725-d19a-4d69-b9da-759443d8425d",
          "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
          "CreateUser": "sample string 3",
          "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
          "LastModifiedUser": "sample string 4"
        },
        "FormValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
        "MeasurementValueNeededDate": "2025-07-18T23:56:32.6314433-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "f0b9a8c1-b65c-4e29-8627-e3018a765713",
        "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "EffectiveDate": "2025-07-18T23:56:32.6314433-07:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "69ba89ee-1ec9-4606-819c-6dfab42d0f09",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "b2ebc3fe-6390-43b0-b66c-85bf3fa154d7",
        "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "2b3fe76b-315d-492f-999b-66f5912b9813",
      "CreateDate": "2025-07-18T23:56:32.6314433-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-07-18T23:56:32.6314433-07:00",
      "LastModifiedUser": "sample string 4"
    }
  ],
  "Total": 1,
  "Message": "sample string 1"
}