POST api/Insured/InsuredSMS

Insured Sms list endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of insured database Ids.

InsuredDataBaseIds
NameDescriptionTypeAdditional information
InsuredDataBaseId

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "insuredDataBaseId": [
    "1c0053da-7f4e-4fd3-b56d-f5144fecb624",
    "6d7331b3-26b2-4630-a828-56bd2b92c909"
  ]
}

application/xml, text/xml

Sample:
<InsuredDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
  <InsuredDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1c0053da-7f4e-4fd3-b56d-f5144fecb624</d2p1:guid>
    <d2p1:guid>6d7331b3-26b2-4630-a828-56bd2b92c909</d2p1:guid>
  </InsuredDataBaseId>
</InsuredDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of InsuredSMS against given insured database Ids.

InsuredSMS
NameDescriptionTypeAdditional information
DateAndTime

date

None.

FromNumber

string

None.

ToNumber

string

None.

Subject

string

None.

FromName

string

None.

ToName

string

None.

ConversationId

string

None.

MessageId

string

None.

IsRead

boolean

None.

SystemType

string

None.

InsuredDatabaseId

globally unique identifier

None.

InsuredEmail

string

None.

InsuredFirstName

string

None.

InsuredLastName

string

None.

InsuredCommercialName

string

None.

DatabaseId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "dateAndTime": "2022-08-11T05:24:15.2338582-05:00",
  "fromNumber": "sample string 2",
  "toNumber": "sample string 3",
  "subject": "sample string 4",
  "fromName": "sample string 5",
  "toName": "sample string 6",
  "conversationId": "sample string 7",
  "messageId": "sample string 8",
  "isRead": true,
  "systemType": "sample string 10",
  "insuredDatabaseId": "80ca1909-b9c1-453c-82ed-94ddbeb3dfa8",
  "insuredEmail": "sample string 11",
  "insuredFirstName": "sample string 12",
  "insuredLastName": "sample string 13",
  "insuredCommercialName": "sample string 14",
  "databaseId": "673d21c5-950c-44d7-b00b-343ff1f71e80"
}

application/xml, text/xml

Sample:
<InsuredSMS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <ConversationId>sample string 7</ConversationId>
  <DatabaseId>673d21c5-950c-44d7-b00b-343ff1f71e80</DatabaseId>
  <DateAndTime>2022-08-11T05:24:15.2338582-05:00</DateAndTime>
  <FromName>sample string 5</FromName>
  <FromNumber>sample string 2</FromNumber>
  <InsuredCommercialName>sample string 14</InsuredCommercialName>
  <InsuredDatabaseId>80ca1909-b9c1-453c-82ed-94ddbeb3dfa8</InsuredDatabaseId>
  <InsuredEmail>sample string 11</InsuredEmail>
  <InsuredFirstName>sample string 12</InsuredFirstName>
  <InsuredLastName>sample string 13</InsuredLastName>
  <IsRead>true</IsRead>
  <MessageId>sample string 8</MessageId>
  <Subject>sample string 4</Subject>
  <SystemType>sample string 10</SystemType>
  <ToName>sample string 6</ToName>
  <ToNumber>sample string 3</ToNumber>
</InsuredSMS>