GET breeze/NE/CallEntities

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CallEntity
NameDescriptionTypeAdditional information
CallEntityId

integer

None.

CallId

integer

None.

EntityNameId

integer

None.

EntityId

integer

None.

IsSelf

boolean

None.

CallerRelationshipId

integer

None.

IsSubjectPresent

boolean

None.

FirstName

string

None.

LastName

string

None.

BirthDate

date

None.

SSN

string

None.

PhoneNumber

string

None.

EmailAddress

string

None.

AddressLine1

string

None.

AddressLine2

string

None.

City

string

None.

StateId

integer

None.

Zip

string

None.

Zip4

string

None.

Call

Call

None.

EntityName

EntityName

None.

CallerRelationship

Relationship

None.

State

State

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.HT.CallEntity, NE.Entities.Server",
    "CallEntityId": 1,
    "CallId": 2,
    "EntityNameId": 1,
    "EntityId": 1,
    "IsSelf": true,
    "CallerRelationshipId": 1,
    "IsSubjectPresent": true,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "BirthDate": "2022-08-13T21:22:43.048+00:00",
    "SSN": "sample string 6",
    "PhoneNumber": "sample string 7",
    "EmailAddress": "sample string 8",
    "AddressLine1": "sample string 9",
    "AddressLine2": "sample string 10",
    "City": "sample string 11",
    "StateId": 1,
    "Zip": "sample string 12",
    "Zip4": "sample string 13",
    "Call": {
      "$id": "2",
      "$type": "NE.Entities.Server.HT.Call, NE.Entities.Server",
      "CallId": 1,
      "CallDirectionId": 2,
      "CallersLanguageId": 1,
      "CallerTypeId": 1,
      "CallResolutionId": 1,
      "CallUnableToContactReasonId": 1,
      "CallTransferredToId": 1,
      "CallIncompleteReasonId": 1,
      "CallDissatisfiedReasonId": 1,
      "StartDateTime": "2022-08-13T21:22:43.048+00:00",
      "EndDateTime": "2022-08-13T21:22:43.048+00:00",
      "CallersFirstName": "sample string 4",
      "CallersLastName": "sample string 5",
      "Notes": "sample string 6",
      "OtherCallerType": "sample string 7",
      "CreatedBy": 8,
      "SourceEntityNameId": 1,
      "SourceEntityId": 1,
      "IsDeleted": true,
      "PhoneNumber": "sample string 10",
      "InterpreterUsed": true,
      "RecordingPath": "sample string 11",
      "ModifiedBy": 1,
      "ModifiedDate": "2022-08-13T21:22:43.048+00:00",
      "CreatedDate": "2022-08-13T21:22:43.048+00:00",
      "CallersEmailAddress": "sample string 13",
      "CallCallActions": [
        {
          "$id": "3",
          "$type": "NE.Entities.Server.HT.CallCallAction, NE.Entities.Server",
          "CallCallActionId": 1,
          "CallActionId": 2,
          "CallId": 3,
          "EntityId": 1,
          "EntityNameId": 1,
          "OtherText": "sample string 4",
          "CallEntityId": 1,
          "Call": {
            "$ref": "2"
          },
          "CallAction": {
            "$id": "4",
            "$type": "NE.Entities.Server.HT.CallAction, NE.Entities.Server",
            "CallActionId": 1,
            "CallActionCategoryId": 2,
            "Description": "sample string 3",
            "IsSystemOnly": true,
            "IsOtherTextRequired": true,
            "IsActive": true,
            "CodeName": "sample string 7",
            "PermissionId": 1,
            "HelpfulHintId": 1,
            "CallActionCategory": {
              "$id": "5",
              "$type": "NE.Entities.Server.HT.CallActionCategory, NE.Entities.Server",
              "CallActionCategoryId": 1,
              "Description": "sample string 2",
              "CodeName": "sample string 3",
              "AllowMultipleActions": true,
              "HelpfulHintId": 1,
              "CallActions": [
                {
                  "$ref": "4"
                },
                {
                  "$ref": "4"
                }
              ],
              "HelpfulHint": {
                "$id": "6",
                "$type": "AHS.Server.Entities.HelpfulHint, AHS.Server",
                "HelpfulHintId": 1,
                "HelpfulHintTypeId": 64,
                "Description": "sample string 3",
                "CodeName": "sample string 4",
                "ToolTip": "sample string 5",
                "Path": "sample string 6",
                "Location": "sample string 7",
                "HelpfulHintType": {
                  "$id": "7",
                  "$type": "AHS.Server.Entities.HelpfulHintType, AHS.Server",
                  "HelpfulHintTypeId": 64,
                  "Description": "sample string 2",
                  "CodeName": "sample string 3",
                  "HelpfulHints": [
                    {
                      "$ref": "6"
                    },
                    {
                      "$ref": "6"
                    }
                  ]
                }
              }
            },
            "HelpfulHint": {
              "$ref": "6"
            }
          },
          "EntityName": {
            "$id": "8",
            "$type": "AHS.Server.Entities.EntityName, AHS.Server",
            "EntityNameId": 1,
            "Description": "sample string 2",
            "CodeName": "sample string 3"
          },
          "CallEntity": {
            "$ref": "1"
          }
        },
        {
          "$ref": "3"
        }
      ],
      "CallEntities": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "CallDirection": {
        "$id": "9",
        "$type": "NE.Entities.Server.HT.CallDirection, NE.Entities.Server",
        "CallDirectionId": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3",
        "IsForUI": true,
        "CallResolutions": [
          {
            "$id": "10",
            "$type": "NE.Entities.Server.HT.CallResolution, NE.Entities.Server",
            "CallResolutionId": 1,
            "Description": "sample string 2",
            "CallDirectionId": 3,
            "WasContacted": true,
            "CodeName": "sample string 5",
            "IsActive": true,
            "ShowTransferredTo": true,
            "ShowUnableToContactReason": true,
            "ShowIncompleteReason": true,
            "ShowDissatisfiedReason": true,
            "CallDirection": {
              "$ref": "9"
            }
          },
          {
            "$ref": "10"
          }
        ]
      },
      "CallDissatisfiedReason": {
        "$id": "11",
        "$type": "NE.Entities.Server.HT.CallDissatisfiedReason, NE.Entities.Server",
        "CallDissatisfiedReasonId": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3"
      },
      "CallersLanguage": {
        "$id": "12",
        "$type": "AHS.Server.Entities.Language, AHS.Server",
        "LanguageId": 1,
        "Description": "sample string 2",
        "Code": "sample string 3"
      },
      "CallerType": {
        "$id": "13",
        "$type": "NE.Entities.Server.HT.CallerType, NE.Entities.Server",
        "CallerTypeId": 1,
        "Description": "sample string 2",
        "IsActive": true,
        "CodeName": "sample string 4",
        "IsOtherTextRequired": true,
        "LinkCallToEntityNameId": 1,
        "EntityName": {
          "$ref": "8"
        }
      },
      "CallIncompleteReason": {
        "$id": "14",
        "$type": "NE.Entities.Server.HT.CallIncompleteReason, NE.Entities.Server",
        "CallIncompleteReasonId": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3"
      },
      "CallResolution": {
        "$ref": "10"
      },
      "CallTransferredTo": {
        "$id": "15",
        "$type": "NE.Entities.Server.HT.CallTransferredTo, NE.Entities.Server",
        "CallTransferredToId": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3",
        "IsActive": true
      },
      "CallUnableToContactReason": {
        "$id": "16",
        "$type": "NE.Entities.Server.HT.CallUnableToContactReason, NE.Entities.Server",
        "CallUnableToContactReasonId": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3"
      },
      "EntityName": {
        "$ref": "8"
      },
      "CreatedByUser": {
        "$id": "17",
        "$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": "18",
          "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
          "BusinessUnitId": 1,
          "Description": "sample string 2",
          "IsAHS": true
        }
      }
    },
    "EntityName": {
      "$ref": "8"
    },
    "CallerRelationship": {
      "$id": "19",
      "$type": "AHS.Server.Entities.Relationship, AHS.Server",
      "RelationshipId": 1,
      "Description": "sample string 2",
      "CodeName": "sample string 3"
    },
    "State": {
      "$id": "20",
      "$type": "AHS.Server.Entities.State, AHS.Server",
      "StateId": 1,
      "Name": "sample string 2",
      "Abbreviation": "sample string 3"
    }
  },
  {
    "$ref": "1"
  }
]