GET States?stateId={stateId}

Retrieves a state by its Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stateId

Id of the state

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

On success, the state.

NameDescriptionTypeAdditional information
Data

State

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "StateId": "2e884d18-f50c-4df3-b79b-33c211971d82",
    "Asset": {
      "AssetId": "dd90a315-53ac-42e0-8cfd-506068bd014c",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "aced8caf-f611-489f-b6d6-ceb065f1375b",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "4771ba44-0b13-43c7-864a-41a8c63541dc",
        "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "337ec316-c905-4cd1-8aaa-17a8b100f4a1",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2024-12-21T18:52:56.1788294-08:00",
        "MeasurementValueNeededDate": "2024-12-21T18:52:56.1788294-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "2088b82b-e340-4b4b-9ac0-d729fd779336",
        "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "Status": {
        "StatusId": "f705f6dd-7a2b-46f2-af53-9227a378e261",
        "EffectiveDate": "2024-12-21T18:52:56.1788294-08:00",
        "StatusType": {
          "StatusTypeId": "f96c32c9-017b-4a54-999a-dee35c86ac69",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "aced8caf-f611-489f-b6d6-ceb065f1375b",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "4771ba44-0b13-43c7-864a-41a8c63541dc",
            "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "b2713edc-b25e-4e96-9955-9f1437695fdb",
          "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "e69b48f6-fb16-41ec-b07c-0b258e35c880",
        "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "0d7e9cb2-be96-48eb-9e46-b7cbfee41928",
        "EffectiveDate": "2024-12-21T18:52:56.1788294-08:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "184365cb-2aec-45c8-873d-e37b1ad7a661",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "91fd885f-4a96-42d7-a3f1-9a221b073875",
          "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "594892fc-f67c-4738-9bee-80c219a172e2",
        "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2024-12-21T18:52:56.1788294-08:00",
      "MeasurementValueNeededDate": "2024-12-21T18:52:56.1788294-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "54782c0b-a1ee-4193-bd8d-81366c7b261b",
      "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "EffectiveDate": "2024-12-21T18:52:56.1788294-08:00",
    "StateType": {
      "StateTypeId": "fc54040a-c23f-4b41-9ea4-39132ab120a7",
      "Name": "sample string 1",
      "IsOperational": true,
      "AssetType": {
        "AssetTypeId": "aced8caf-f611-489f-b6d6-ceb065f1375b",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "4771ba44-0b13-43c7-864a-41a8c63541dc",
        "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "SourceSystemId": "sample string 3",
      "CompanyId": "ba5edce3-30f4-4673-813f-504869f5e370",
      "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "SourceSystemId": "sample string 1",
    "CompanyId": "6400a418-a336-477d-bef9-8a180c881016",
    "CreateDate": "2024-12-21T18:52:56.1788294-08:00",
    "CreateUser": "sample string 3",
    "LastModifiedDate": "2024-12-21T18:52:56.1788294-08:00",
    "LastModifiedUser": "sample string 4"
  },
  "Total": 1,
  "Message": "sample string 1"
}