POST api/Insured/InsuredNotes

Insured notes 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": [
    "b2fb6495-d8f4-40ad-a05e-745627c1d287",
    "a1825523-7b68-4e6b-9789-b374aca0154e"
  ]
}

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>b2fb6495-d8f4-40ad-a05e-745627c1d287</d2p1:guid>
    <d2p1:guid>a1825523-7b68-4e6b-9789-b374aca0154e</d2p1:guid>
  </InsuredDataBaseId>
</InsuredDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of InsuredNotes against given insured database Ids.

InsuredNotes
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Subject

string

None.

InsuredDatabaseId

globally unique identifier

None.

InsuredEmail

string

None.

InsuredFirstName

string

None.

InsuredLastName

string

None.

InsuredCommercialName

string

None.

CreateDate

date

None.

CreatorName

string

None.

Type

string

None.

ParentNoteId

globally unique identifier

None.

Hide

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "f3bc5b0f-fc06-43a1-8ae1-0b4b7618b879",
  "subject": "sample string 2",
  "insuredDatabaseId": "d7807621-da90-45ce-a4eb-86d7ff42465b",
  "insuredEmail": "sample string 3",
  "insuredFirstName": "sample string 4",
  "insuredLastName": "sample string 5",
  "insuredCommercialName": "sample string 6",
  "createDate": "2024-04-25T17:38:53.3197561-05:00",
  "creatorName": "sample string 8",
  "type": "sample string 9",
  "parentNoteId": "e1b9cebc-a17a-473e-baae-5f68053b802e",
  "hide": true
}

application/xml, text/xml

Sample:
<InsuredNotes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <CreateDate>2024-04-25T17:38:53.3197561-05:00</CreateDate>
  <CreatorName>sample string 8</CreatorName>
  <DatabaseId>f3bc5b0f-fc06-43a1-8ae1-0b4b7618b879</DatabaseId>
  <Hide>true</Hide>
  <InsuredCommercialName>sample string 6</InsuredCommercialName>
  <InsuredDatabaseId>d7807621-da90-45ce-a4eb-86d7ff42465b</InsuredDatabaseId>
  <InsuredEmail>sample string 3</InsuredEmail>
  <InsuredFirstName>sample string 4</InsuredFirstName>
  <InsuredLastName>sample string 5</InsuredLastName>
  <ParentNoteId>e1b9cebc-a17a-473e-baae-5f68053b802e</ParentNoteId>
  <Subject>sample string 2</Subject>
  <Type>sample string 9</Type>
</InsuredNotes>