PUT v1/Contacts/Notes

Create a new note

Request Information

URI Parameters

None.

Body Parameters

NoteDTO
NameDescriptionTypeAdditional information
Id

integer

None.

Comment

string

None.

CreatedBy

string

None.

EmployeeId

integer

None.

CreatedOn

string

None.

ParentId

integer

None.

AssignedPolicyId

integer

None.

AssignedContactId

integer

None.

Important

boolean

None.

RelatedNotes

Collection of RelatedNoteDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Comment": "sample string 2",
  "CreatedBy": "sample string 3",
  "EmployeeId": 1,
  "CreatedOn": "sample string 4",
  "ParentId": 1,
  "AssignedPolicyId": 1,
  "AssignedContactId": 5,
  "Important": true,
  "RelatedNotes": [
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 5,
      "Important": true
    },
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 5,
      "Important": true
    }
  ]
}

application/xml, text/xml

Sample:
<NoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <AssignedContactId>5</AssignedContactId>
  <AssignedPolicyId>1</AssignedPolicyId>
  <Comment>sample string 2</Comment>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedOn>sample string 4</CreatedOn>
  <EmployeeId>1</EmployeeId>
  <Id>1</Id>
  <Important>true</Important>
  <ParentId>1</ParentId>
  <RelatedNotes>
    <RelatedNoteDTO>
      <AssignedContactId>5</AssignedContactId>
      <AssignedPolicyId>1</AssignedPolicyId>
      <Comment>sample string 2</Comment>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedOn>sample string 4</CreatedOn>
      <EmployeeId>1</EmployeeId>
      <Id>1</Id>
      <Important>true</Important>
      <ParentId>1</ParentId>
    </RelatedNoteDTO>
    <RelatedNoteDTO>
      <AssignedContactId>5</AssignedContactId>
      <AssignedPolicyId>1</AssignedPolicyId>
      <Comment>sample string 2</Comment>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedOn>sample string 4</CreatedOn>
      <EmployeeId>1</EmployeeId>
      <Id>1</Id>
      <Important>true</Important>
      <ParentId>1</ParentId>
    </RelatedNoteDTO>
  </RelatedNotes>
</NoteDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActionResultDTOOfNoteDTO
NameDescriptionTypeAdditional information
Result

NoteDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Id": 1,
    "Comment": "sample string 2",
    "CreatedBy": "sample string 3",
    "EmployeeId": 1,
    "CreatedOn": "sample string 4",
    "ParentId": 1,
    "AssignedPolicyId": 1,
    "AssignedContactId": 5,
    "Important": true,
    "RelatedNotes": [
      {
        "Id": 1,
        "Comment": "sample string 2",
        "CreatedBy": "sample string 3",
        "EmployeeId": 1,
        "CreatedOn": "sample string 4",
        "ParentId": 1,
        "AssignedPolicyId": 1,
        "AssignedContactId": 5,
        "Important": true
      },
      {
        "Id": 1,
        "Comment": "sample string 2",
        "CreatedBy": "sample string 3",
        "EmployeeId": 1,
        "CreatedOn": "sample string 4",
        "ParentId": 1,
        "AssignedPolicyId": 1,
        "AssignedContactId": 5,
        "Important": true
      }
    ]
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
    <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
    <d2p1:Comment>sample string 2</d2p1:Comment>
    <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
    <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
    <d2p1:EmployeeId>1</d2p1:EmployeeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Important>true</d2p1:Important>
    <d2p1:ParentId>1</d2p1:ParentId>
    <d2p1:RelatedNotes>
      <d2p1:RelatedNoteDTO>
        <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
        <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
        <d2p1:Comment>sample string 2</d2p1:Comment>
        <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
        <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
        <d2p1:EmployeeId>1</d2p1:EmployeeId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:ParentId>1</d2p1:ParentId>
      </d2p1:RelatedNoteDTO>
      <d2p1:RelatedNoteDTO>
        <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
        <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
        <d2p1:Comment>sample string 2</d2p1:Comment>
        <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
        <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
        <d2p1:EmployeeId>1</d2p1:EmployeeId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:ParentId>1</d2p1:ParentId>
      </d2p1:RelatedNoteDTO>
    </d2p1:RelatedNotes>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfNoteDTO>