GET Notes/ByEffectiveDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}

Retrieves notes for the given parameters. All parameters are optional.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
assetId

Id of the asset

globally unique identifier

None.

beginDate

Beginning effective date of the notes to retrieve

date

None.

endDate

Ending effective date of the notes to retrieve

date

None.

Body Parameters

None.

Response Information

Resource Description

On success, a list of notes.

NameDescriptionTypeAdditional information
Data

Collection of Note

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "NoteId": "031f407c-3085-4c68-9796-b0c1704d365f",
      "Asset": {
        "AssetId": "9f2840f7-ae5f-4741-a36e-611bb8703aa3",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "2fcde7af-697b-432c-b258-9e6b8fb276a4",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "DisplayColor": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "f8b7961f-57bb-4025-b055-bf347044bf0a",
          "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
          "CreateUser": "sample string 6",
          "CreateMachine": "sample string 7",
          "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
          "LastModifiedUser": "sample string 8",
          "LastModifiedMachine": "sample string 9"
        },
        "AssetGroup": {
          "AssetGroupId": "525787d0-3cc5-46b4-8361-8fec0aed9f74",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
          "MeasurementValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "aa5b8afe-eafd-4e6a-9c56-1b63101c2c8f",
          "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        "ParentAsset": null,
        "WellKnownText": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "FormValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
        "MeasurementValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "982d8c6a-d71f-460d-9642-a6212e4a7e39",
        "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
        "CreateUser": "sample string 7",
        "CreateMachine": "sample string 8",
        "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
        "LastModifiedUser": "sample string 9",
        "LastModifiedMachine": "sample string 10"
      },
      "EffectiveDate": "2021-04-17T08:19:27.0004094-07:00",
      "NoteHTML": "sample string 1",
      "SourceSystemId": "sample string 2",
      "CompanyId": "3086d6b4-f901-4655-be92-44a52bf9c8b9",
      "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
      "CreateUser": "sample string 4",
      "CreateMachine": "sample string 5",
      "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
      "LastModifiedUser": "sample string 6",
      "LastModifiedMachine": "sample string 7"
    },
    {
      "NoteId": "031f407c-3085-4c68-9796-b0c1704d365f",
      "Asset": {
        "AssetId": "9f2840f7-ae5f-4741-a36e-611bb8703aa3",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "2fcde7af-697b-432c-b258-9e6b8fb276a4",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "DisplayColor": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "f8b7961f-57bb-4025-b055-bf347044bf0a",
          "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
          "CreateUser": "sample string 6",
          "CreateMachine": "sample string 7",
          "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
          "LastModifiedUser": "sample string 8",
          "LastModifiedMachine": "sample string 9"
        },
        "AssetGroup": {
          "AssetGroupId": "525787d0-3cc5-46b4-8361-8fec0aed9f74",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
          "MeasurementValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "aa5b8afe-eafd-4e6a-9c56-1b63101c2c8f",
          "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        "ParentAsset": null,
        "WellKnownText": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "FormValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
        "MeasurementValueNeededDate": "2021-04-17T08:19:27.0004094-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "982d8c6a-d71f-460d-9642-a6212e4a7e39",
        "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
        "CreateUser": "sample string 7",
        "CreateMachine": "sample string 8",
        "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
        "LastModifiedUser": "sample string 9",
        "LastModifiedMachine": "sample string 10"
      },
      "EffectiveDate": "2021-04-17T08:19:27.0004094-07:00",
      "NoteHTML": "sample string 1",
      "SourceSystemId": "sample string 2",
      "CompanyId": "3086d6b4-f901-4655-be92-44a52bf9c8b9",
      "CreateDate": "2021-04-17T08:19:27.0004094-07:00",
      "CreateUser": "sample string 4",
      "CreateMachine": "sample string 5",
      "LastModifiedDate": "2021-04-17T08:19:27.0004094-07:00",
      "LastModifiedUser": "sample string 6",
      "LastModifiedMachine": "sample string 7"
    }
  ],
  "Total": 1,
  "Message": "sample string 1"
}