POST api/NTSummary/SendAppointmentTextMessage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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 20
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": "2024-11-21T00:31:53.2904208-08:00",
      "DateUpdated": "2024-11-21T00:31:53.2904208-08: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": "2024-11-21T00:31:53.2904208-08:00",
      "DateUpdated": "2024-11-21T00:31:53.2904208-08:00",
      "UserIDCreated": 10,
      "UserIDUpdated": 11,
      "CompanyCode": "sample string 12",
      "IsExcludeDiscount": true
    }
  ],
  "Sequence": 8,
  "ClinicalPathwayTypeId": 9,
  "ClinicalPathwayId": 1,
  "OpenDate": "2024-11-21T00:31:53.2904208-08:00",
  "ClinicalPathwayTypeName": "sample string 10",
  "EmployeeId": "sample string 11",
  "IsAppointmentText": true,
  "OrderDescription": "sample string 13",
  "ValidFlag": true,
  "DateCreated": "2024-11-21T00:31:53.2904208-08:00",
  "DateUpdated": "2024-11-21T00:31:53.2904208-08:00",
  "UserIDCreated": 17,
  "UserIDUpdated": 18,
  "CompanyCode": "sample string 19",
  "IsExcludeDiscount": true
}

application/xml, text/xml

Sample:

<TextMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CompanyCode>sample string 19</CompanyCode>
  <DateCreated>2024-11-21T00:31:53.2904208-08:00</DateCreated>
  <DateUpdated>2024-11-21T00:31:53.2904208-08:00</DateUpdated>
  <IsExcludeDiscount>true</IsExcludeDiscount>
  <UserIDCreated>17</UserIDCreated>
  <UserIDUpdated>18</UserIDUpdated>
  <ValidFlag>true</ValidFlag>
  <CaseNo>1</CaseNo>
  <ClinicalPathwayId>1</ClinicalPathwayId>
  <ClinicalPathwayTypeId>9</ClinicalPathwayTypeId>
  <ClinicalPathwayTypeName>sample string 10</ClinicalPathwayTypeName>
  <CorporationCode>sample string 6</CorporationCode>
  <CreatedUserName>sample string 5</CreatedUserName>
  <EmployeeId>sample string 11</EmployeeId>
  <EnRouteId>1</EnRouteId>
  <EncounterId>1</EncounterId>
  <Id>1</Id>
  <IsAppointmentText>true</IsAppointmentText>
  <OpenDate>2024-11-21T00:31:53.2904208-08:00</OpenDate>
  <OrderDescription>sample string 13</OrderDescription>
  <Sequence>8</Sequence>
  <TextBody>sample string 2</TextBody>
  <TextList>
    <NotifyTextDetailDTO>
      <CompanyCode>sample string 12</CompanyCode>
      <DateCreated>2024-11-21T00:31:53.2904208-08:00</DateCreated>
      <DateUpdated>2024-11-21T00:31:53.2904208-08:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>10</UserIDCreated>
      <UserIDUpdated>11</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <ClinicalPathwayTypeId>5</ClinicalPathwayTypeId>
      <ClinicalPathwayTypeName>sample string 6</ClinicalPathwayTypeName>
      <FirstName>sample string 2</FirstName>
      <Id>1</Id>
      <LastName>sample string 3</LastName>
      <Status>1</Status>
      <Text>sample string 4</Text>
      <TextSourceType>1</TextSourceType>
    </NotifyTextDetailDTO>
    <NotifyTextDetailDTO>
      <CompanyCode>sample string 12</CompanyCode>
      <DateCreated>2024-11-21T00:31:53.2904208-08:00</DateCreated>
      <DateUpdated>2024-11-21T00:31:53.2904208-08:00</DateUpdated>
      <IsExcludeDiscount>true</IsExcludeDiscount>
      <UserIDCreated>10</UserIDCreated>
      <UserIDUpdated>11</UserIDUpdated>
      <ValidFlag>true</ValidFlag>
      <ClinicalPathwayTypeId>5</ClinicalPathwayTypeId>
      <ClinicalPathwayTypeName>sample string 6</ClinicalPathwayTypeName>
      <FirstName>sample string 2</FirstName>
      <Id>1</Id>
      <LastName>sample string 3</LastName>
      <Status>1</Status>
      <Text>sample string 4</Text>
      <TextSourceType>1</TextSourceType>
    </NotifyTextDetailDTO>
  </TextList>
  <TextNotificationType>sample string 3</TextNotificationType>
  <TextNotificationTypeId>4</TextNotificationTypeId>
  <WLCode>sample string 7</WLCode>
</TextMessageDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfTextMessageDTO

Name	Type	Additional 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": "2024-11-21T00:31:53.3437328-08:00",
        "DateUpdated": "2024-11-21T00:31:53.3437328-08: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": "2024-11-21T00:31:53.3437328-08:00",
        "DateUpdated": "2024-11-21T00:31:53.3437328-08:00",
        "UserIDCreated": 10,
        "UserIDUpdated": 11,
        "CompanyCode": "sample string 12",
        "IsExcludeDiscount": true
      }
    ],
    "Sequence": 8,
    "ClinicalPathwayTypeId": 9,
    "ClinicalPathwayId": 1,
    "OpenDate": "2024-11-21T00:31:53.3437328-08:00",
    "ClinicalPathwayTypeName": "sample string 10",
    "EmployeeId": "sample string 11",
    "IsAppointmentText": true,
    "OrderDescription": "sample string 13",
    "ValidFlag": true,
    "DateCreated": "2024-11-21T00:31:53.3437328-08:00",
    "DateUpdated": "2024-11-21T00:31:53.3437328-08:00",
    "UserIDCreated": 17,
    "UserIDUpdated": 18,
    "CompanyCode": "sample string 19",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:

<AsapResponseOfTextMessageDTO3NYuOdgi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.Common">
  <isSuccess>true</isSuccess>
  <jsonObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
    <d2p1:CompanyCode>sample string 19</d2p1:CompanyCode>
    <d2p1:DateCreated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateCreated>
    <d2p1:DateUpdated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateUpdated>
    <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
    <d2p1:UserIDCreated>17</d2p1:UserIDCreated>
    <d2p1:UserIDUpdated>18</d2p1:UserIDUpdated>
    <d2p1:ValidFlag>true</d2p1:ValidFlag>
    <d2p1:CaseNo>1</d2p1:CaseNo>
    <d2p1:ClinicalPathwayId>1</d2p1:ClinicalPathwayId>
    <d2p1:ClinicalPathwayTypeId>9</d2p1:ClinicalPathwayTypeId>
    <d2p1:ClinicalPathwayTypeName>sample string 10</d2p1:ClinicalPathwayTypeName>
    <d2p1:CorporationCode>sample string 6</d2p1:CorporationCode>
    <d2p1:CreatedUserName>sample string 5</d2p1:CreatedUserName>
    <d2p1:EmployeeId>sample string 11</d2p1:EmployeeId>
    <d2p1:EnRouteId>1</d2p1:EnRouteId>
    <d2p1:EncounterId>1</d2p1:EncounterId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsAppointmentText>true</d2p1:IsAppointmentText>
    <d2p1:OpenDate>2024-11-21T00:31:53.3437328-08:00</d2p1:OpenDate>
    <d2p1:OrderDescription>sample string 13</d2p1:OrderDescription>
    <d2p1:Sequence>8</d2p1:Sequence>
    <d2p1:TextBody>sample string 2</d2p1:TextBody>
    <d2p1:TextList>
      <d2p1:NotifyTextDetailDTO>
        <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
        <d2p1:DateCreated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:ClinicalPathwayTypeId>5</d2p1:ClinicalPathwayTypeId>
        <d2p1:ClinicalPathwayTypeName>sample string 6</d2p1:ClinicalPathwayTypeName>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:Status>1</d2p1:Status>
        <d2p1:Text>sample string 4</d2p1:Text>
        <d2p1:TextSourceType>1</d2p1:TextSourceType>
      </d2p1:NotifyTextDetailDTO>
      <d2p1:NotifyTextDetailDTO>
        <d2p1:CompanyCode>sample string 12</d2p1:CompanyCode>
        <d2p1:DateCreated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateCreated>
        <d2p1:DateUpdated>2024-11-21T00:31:53.3437328-08:00</d2p1:DateUpdated>
        <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
        <d2p1:UserIDCreated>10</d2p1:UserIDCreated>
        <d2p1:UserIDUpdated>11</d2p1:UserIDUpdated>
        <d2p1:ValidFlag>true</d2p1:ValidFlag>
        <d2p1:ClinicalPathwayTypeId>5</d2p1:ClinicalPathwayTypeId>
        <d2p1:ClinicalPathwayTypeName>sample string 6</d2p1:ClinicalPathwayTypeName>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:Status>1</d2p1:Status>
        <d2p1:Text>sample string 4</d2p1:Text>
        <d2p1:TextSourceType>1</d2p1:TextSourceType>
      </d2p1:NotifyTextDetailDTO>
    </d2p1:TextList>
    <d2p1:TextNotificationType>sample string 3</d2p1:TextNotificationType>
    <d2p1:TextNotificationTypeId>4</d2p1:TextNotificationTypeId>
    <d2p1:WLCode>sample string 7</d2p1:WLCode>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfTextMessageDTO3NYuOdgi>