POST api/NTSummary/SendAppointmentTextMessage

Request Information

URI Parameters

None.

Body Parameters

TextMessageDTO
NameDescriptionTypeAdditional information
Id

integer

None.

CaseNo

integer

None.

EncounterId

integer

None.

TextBody

string

String length: inclusive between 0 and 2147483647

TextNotificationType

string

String length: inclusive between 0 and 250

TextNotificationTypeId

integer

None.

CreatedUserName

string

String length: inclusive between 0 and 60

CorporationCode

string

String length: inclusive between 0 and 20

WLCode

string

String length: inclusive between 0 and 20

EnRouteId

integer

None.

TextList

Collection of NotifyTextDetailDTO

None.

Sequence

integer

None.

ClinicalPathwayTypeId

integer

None.

ClinicalPathwayId

integer

None.

OpenDate

date

None.

ClinicalPathwayTypeName

string

String length: inclusive between 0 and 100

EmployeeId

string

String length: inclusive between 0 and 12

IsAppointmentText

boolean

None.

OrderDescription

string

None.

ValidFlag

boolean

None.

DateCreated

date

None.

DateUpdated

date

None.

UserIDCreated

integer

None.

UserIDUpdated

integer

None.

CompanyCode

string

String length: inclusive between 0 and 10

IsExcludeDiscount

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "CaseNo": 1,
  "EncounterId": 1,
  "TextBody": "sample string 2",
  "TextNotificationType": "sample string 3",
  "TextNotificationTypeId": 4,
  "CreatedUserName": "sample string 5",
  "CorporationCode": "sample string 6",
  "WLCode": "sample string 7",
  "EnRouteId": 1,
  "TextList": [
    {
      "Id": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Text": "sample string 4",
      "FullName": "sample string 2 sample string 3 sample string 4",
      "TextSourceType": 1,
      "Status": 1,
      "ClinicalPathwayTypeId": 5,
      "ClinicalPathwayTypeName": "sample string 6",
      "ValidFlag": true,
      "DateCreated": "2026-08-04T02:13:22.3154549-07:00",
      "DateUpdated": "2026-08-04T02:13:22.3154549-07:00",
      "UserIDCreated": 10,
      "UserIDUpdated": 11,
      "CompanyCode": "sample string 12",
      "IsExcludeDiscount": true
    },
    {
      "Id": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Text": "sample string 4",
      "FullName": "sample string 2 sample string 3 sample string 4",
      "TextSourceType": 1,
      "Status": 1,
      "ClinicalPathwayTypeId": 5,
      "ClinicalPathwayTypeName": "sample string 6",
      "ValidFlag": true,
      "DateCreated": "2026-08-04T02:13:22.3154549-07:00",
      "DateUpdated": "2026-08-04T02:13:22.3154549-07:00",
      "UserIDCreated": 10,
      "UserIDUpdated": 11,
      "CompanyCode": "sample string 12",
      "IsExcludeDiscount": true
    }
  ],
  "Sequence": 8,
  "ClinicalPathwayTypeId": 9,
  "ClinicalPathwayId": 1,
  "OpenDate": "2026-08-04T02:13:22.3154549-07:00",
  "ClinicalPathwayTypeName": "sample string 10",
  "EmployeeId": "sample string 11",
  "IsAppointmentText": true,
  "OrderDescription": "sample string 13",
  "ValidFlag": true,
  "DateCreated": "2026-08-04T02:13:22.3154549-07:00",
  "DateUpdated": "2026-08-04T02:13:22.3154549-07:00",
  "UserIDCreated": 17,
  "UserIDUpdated": 18,
  "CompanyCode": "sample string 19",
  "IsExcludeDiscount": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfTextMessageDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

TextMessageDTO

None.

totalCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "CaseNo": 1,
    "EncounterId": 1,
    "TextBody": "sample string 2",
    "TextNotificationType": "sample string 3",
    "TextNotificationTypeId": 4,
    "CreatedUserName": "sample string 5",
    "CorporationCode": "sample string 6",
    "WLCode": "sample string 7",
    "EnRouteId": 1,
    "TextList": [
      {
        "Id": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Text": "sample string 4",
        "FullName": "sample string 2 sample string 3 sample string 4",
        "TextSourceType": 1,
        "Status": 1,
        "ClinicalPathwayTypeId": 5,
        "ClinicalPathwayTypeName": "sample string 6",
        "ValidFlag": true,
        "DateCreated": "2026-08-04T02:13:22.3310722-07:00",
        "DateUpdated": "2026-08-04T02:13:22.3310722-07:00",
        "UserIDCreated": 10,
        "UserIDUpdated": 11,
        "CompanyCode": "sample string 12",
        "IsExcludeDiscount": true
      },
      {
        "Id": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Text": "sample string 4",
        "FullName": "sample string 2 sample string 3 sample string 4",
        "TextSourceType": 1,
        "Status": 1,
        "ClinicalPathwayTypeId": 5,
        "ClinicalPathwayTypeName": "sample string 6",
        "ValidFlag": true,
        "DateCreated": "2026-08-04T02:13:22.3310722-07:00",
        "DateUpdated": "2026-08-04T02:13:22.3310722-07:00",
        "UserIDCreated": 10,
        "UserIDUpdated": 11,
        "CompanyCode": "sample string 12",
        "IsExcludeDiscount": true
      }
    ],
    "Sequence": 8,
    "ClinicalPathwayTypeId": 9,
    "ClinicalPathwayId": 1,
    "OpenDate": "2026-08-04T02:13:22.3310722-07:00",
    "ClinicalPathwayTypeName": "sample string 10",
    "EmployeeId": "sample string 11",
    "IsAppointmentText": true,
    "OrderDescription": "sample string 13",
    "ValidFlag": true,
    "DateCreated": "2026-08-04T02:13:22.3310722-07:00",
    "DateUpdated": "2026-08-04T02:13:22.3310722-07:00",
    "UserIDCreated": 17,
    "UserIDUpdated": 18,
    "CompanyCode": "sample string 19",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}