PUT v1/Contacts/Notes

Create a new note

Request Information

URI Parameters

None.

Body Parameters

Note to be created

Name	Type	Additional 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.
BulkInsertId	globally unique identifier	None.
BulkInsertSessionId	globally unique identifier	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,
      "BulkInsertId": "fb65138f-e0a3-4bb4-9a2e-84707834ae30",
      "BulkInsertSessionId": "d0e77891-4d31-4f8c-90b7-855f6a0b4fd7"
    },
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 5,
      "Important": true,
      "BulkInsertId": "fb65138f-e0a3-4bb4-9a2e-84707834ae30",
      "BulkInsertSessionId": "d0e77891-4d31-4f8c-90b7-855f6a0b4fd7"
    }
  ],
  "BulkInsertId": "1abfa127-1428-4910-b4ae-fada5c167592",
  "BulkInsertSessionId": "d4849787-e80d-4798-9159-72afa67af7eb"
}

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>
  <BulkInsertId>1abfa127-1428-4910-b4ae-fada5c167592</BulkInsertId>
  <BulkInsertSessionId>d4849787-e80d-4798-9159-72afa67af7eb</BulkInsertSessionId>
  <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>
      <BulkInsertId>fb65138f-e0a3-4bb4-9a2e-84707834ae30</BulkInsertId>
      <BulkInsertSessionId>d0e77891-4d31-4f8c-90b7-855f6a0b4fd7</BulkInsertSessionId>
      <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>
      <BulkInsertId>fb65138f-e0a3-4bb4-9a2e-84707834ae30</BulkInsertId>
      <BulkInsertSessionId>d0e77891-4d31-4f8c-90b7-855f6a0b4fd7</BulkInsertSessionId>
      <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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NoteDTO'.

Response Information

Resource Description

Created note

ActionResultDTOOfNoteDTO

Name	Type	Additional 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,
        "BulkInsertId": "fdbdc90e-2dba-401c-8383-8ae6a00c3061",
        "BulkInsertSessionId": "3fdaa770-1420-4253-9d6b-0e0d24ec7f6f"
      },
      {
        "Id": 1,
        "Comment": "sample string 2",
        "CreatedBy": "sample string 3",
        "EmployeeId": 1,
        "CreatedOn": "sample string 4",
        "ParentId": 1,
        "AssignedPolicyId": 1,
        "AssignedContactId": 5,
        "Important": true,
        "BulkInsertId": "fdbdc90e-2dba-401c-8383-8ae6a00c3061",
        "BulkInsertSessionId": "3fdaa770-1420-4253-9d6b-0e0d24ec7f6f"
      }
    ],
    "BulkInsertId": "3dde9b5b-f1c7-4a96-a64c-edffa191ba7e",
    "BulkInsertSessionId": "6536dc06-4b37-485e-905f-c86048e89659"
  },
  "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:BulkInsertId>3dde9b5b-f1c7-4a96-a64c-edffa191ba7e</d2p1:BulkInsertId>
    <d2p1:BulkInsertSessionId>6536dc06-4b37-485e-905f-c86048e89659</d2p1:BulkInsertSessionId>
    <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:BulkInsertId>fdbdc90e-2dba-401c-8383-8ae6a00c3061</d2p1:BulkInsertId>
        <d2p1:BulkInsertSessionId>3fdaa770-1420-4253-9d6b-0e0d24ec7f6f</d2p1:BulkInsertSessionId>
        <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:BulkInsertId>fdbdc90e-2dba-401c-8383-8ae6a00c3061</d2p1:BulkInsertId>
        <d2p1:BulkInsertSessionId>3fdaa770-1420-4253-9d6b-0e0d24ec7f6f</d2p1:BulkInsertSessionId>
        <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>