GET api/NE/Messages

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Message
NameDescriptionTypeAdditional information
ConversationId

integer

None.

CreatedBy

integer

None.

CreatedDate

date

None.

IsDeleted

boolean

None.

MessageId

integer

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

DisplayName

string

None.

ReadDate

date

None.

SenderEntityId

integer

None.

SenderEntityNameId

integer

None.

Text

string

None.

Conversation

Conversation

None.

CreatedByUser

User

None.

ModifiedByUser

User

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.HT.Message, NE.Entities.Server",
    "ConversationId": 1,
    "CreatedBy": 2,
    "CreatedDate": "2022-11-26T23:20:15.021+00:00",
    "IsDeleted": true,
    "MessageId": 5,
    "ModifiedBy": 1,
    "ModifiedDate": "2022-11-26T23:20:15.021+00:00",
    "DisplayName": "sample string 6",
    "ReadDate": "2022-11-26T23:20:15.021+00:00",
    "SenderEntityId": 7,
    "SenderEntityNameId": 8,
    "Text": "sample string 9",
    "Conversation": {
      "$id": "2",
      "$type": "NE.Entities.Server.HT.Conversation, NE.Entities.Server",
      "ConversationCategoryId": 1,
      "ConversationId": 2,
      "ConversationResponseTypeId": 64,
      "ConversationStatusId": 64,
      "ConversationTypeId": 64,
      "CreatedBy": 6,
      "CreatedDate": "2022-11-26T23:20:15.021+00:00",
      "ModifiedBy": 1,
      "ModifiedDate": "2022-11-26T23:20:15.021+00:00",
      "OtherDescription": "sample string 8",
      "WithEntityId": 9,
      "WithEntityNameId": 10,
      "DisplayName": "sample string 11",
      "ConversationConversationActions": [
        {
          "$id": "3",
          "$type": "NE.Entities.Server.HT.ConversationConversationAction, NE.Entities.Server",
          "ConversationActionId": 1,
          "ConversationConversationActionId": 2,
          "ConversationId": 3,
          "EntityId": 1,
          "EntityNameId": 1,
          "Conversation": {
            "$ref": "2"
          },
          "ConversationAction": {
            "$id": "4",
            "$type": "NE.Entities.Server.HT.ConversationAction, NE.Entities.Server",
            "CodeName": "sample string 1",
            "ConversationActionCategoryId": 64,
            "ConversationActionId": 3,
            "Description": "sample string 4",
            "ConversationConversationActions": [
              {
                "$ref": "3"
              },
              {
                "$ref": "3"
              }
            ],
            "ConversationActionCategory": {
              "$id": "5",
              "$type": "NE.Entities.Server.HT.ConversationActionCategory, NE.Entities.Server",
              "CodeName": "sample string 1",
              "ConversationActionCategoryId": 64,
              "Description": "sample string 3",
              "ConversationActions": [
                {
                  "$ref": "4"
                },
                {
                  "$ref": "4"
                }
              ]
            }
          },
          "EntityName": {
            "$id": "6",
            "$type": "AHS.Server.Entities.EntityName, AHS.Server",
            "EntityNameId": 1,
            "Description": "sample string 2",
            "CodeName": "sample string 3"
          }
        },
        {
          "$ref": "3"
        }
      ],
      "ConversationEntities": [
        {
          "$id": "7",
          "$type": "NE.Entities.Server.HT.ConversationEntity, NE.Entities.Server",
          "ConversationEntityId": 1,
          "ConversationId": 2,
          "EntityId": 3,
          "EntityNameId": 64,
          "Conversation": {
            "$ref": "2"
          }
        },
        {
          "$ref": "7"
        }
      ],
      "Messages": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "ConversationCategory": {
        "$id": "8",
        "$type": "NE.Entities.Server.HT.ConversationCategory, NE.Entities.Server",
        "CodeName": "sample string 1",
        "ConversationCategoryId": 2,
        "Description": "sample string 3",
        "Conversations": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "ConversationResponseType": {
        "$id": "9",
        "$type": "NE.Entities.Server.HT.ConversationResponseType, NE.Entities.Server",
        "CodeName": "sample string 1",
        "ConversationResponseTypeId": 64,
        "Description": "sample string 3",
        "Conversations": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "ConversationStatus": {
        "$id": "10",
        "$type": "NE.Entities.Server.HT.ConversationStatus, NE.Entities.Server",
        "CodeName": "sample string 1",
        "ConversationStatusId": 64,
        "Description": "sample string 3",
        "Conversations": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "ConversationType": {
        "$id": "11",
        "$type": "NE.Entities.Server.HT.ConversationType, NE.Entities.Server",
        "CodeName": "sample string 1",
        "ConversationTypeId": 64,
        "Description": "sample string 3",
        "Conversations": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "CreatedByUser": {
        "$id": "12",
        "$type": "AHS.Server.Entities.User, AHS.Server",
        "UserId": 1,
        "Username": "sample string 2",
        "FirstName": "sample string 3",
        "LastName": "sample string 4",
        "Email": "sample string 5",
        "IsActive": true,
        "IsSystem": true,
        "IsADBased": true,
        "BusinessUnitId": 9,
        "PermissionIds": [
          1,
          2
        ],
        "FullName": "sample string 3 sample string 4",
        "BusinessUnit": {
          "$id": "13",
          "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
          "BusinessUnitId": 1,
          "Description": "sample string 2",
          "IsAHS": true
        }
      },
      "ModifiedByUser": {
        "$ref": "12"
      }
    },
    "CreatedByUser": {
      "$ref": "12"
    },
    "ModifiedByUser": {
      "$ref": "12"
    }
  },
  {
    "$ref": "1"
  }
]