PUT v1/Contacts/Notes
Create a new note
Request Information
URI Parameters
None.
Body Parameters
Note to be created
NoteDTOName | Description | 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": "b4d373b4-9b87-405a-98b0-2dcc44663392", "BulkInsertSessionId": "648c2515-ec7e-409b-873c-92f986ba4d95" }, { "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": "b4d373b4-9b87-405a-98b0-2dcc44663392", "BulkInsertSessionId": "648c2515-ec7e-409b-873c-92f986ba4d95" } ], "BulkInsertId": "efa04ac9-86a3-461c-99cb-75af02e01842", "BulkInsertSessionId": "ac538e58-8690-414b-87b8-1da21c80600c" }
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>efa04ac9-86a3-461c-99cb-75af02e01842</BulkInsertId> <BulkInsertSessionId>ac538e58-8690-414b-87b8-1da21c80600c</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>b4d373b4-9b87-405a-98b0-2dcc44663392</BulkInsertId> <BulkInsertSessionId>648c2515-ec7e-409b-873c-92f986ba4d95</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>b4d373b4-9b87-405a-98b0-2dcc44663392</BulkInsertId> <BulkInsertSessionId>648c2515-ec7e-409b-873c-92f986ba4d95</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:
Response Information
Resource Description
Created note
ActionResultDTOOfNoteDTOName | Description | 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": "4bfc8216-4d6c-42d9-8025-089de177eda3", "BulkInsertSessionId": "40a1b9b1-959f-47ea-ba43-ef8561c198c8" }, { "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": "4bfc8216-4d6c-42d9-8025-089de177eda3", "BulkInsertSessionId": "40a1b9b1-959f-47ea-ba43-ef8561c198c8" } ], "BulkInsertId": "042bb1b9-4033-491c-84f0-ff9d3b23686d", "BulkInsertSessionId": "a6f79ae6-c024-4dde-9049-f8d3bcb642fa" }, "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>042bb1b9-4033-491c-84f0-ff9d3b23686d</d2p1:BulkInsertId> <d2p1:BulkInsertSessionId>a6f79ae6-c024-4dde-9049-f8d3bcb642fa</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>4bfc8216-4d6c-42d9-8025-089de177eda3</d2p1:BulkInsertId> <d2p1:BulkInsertSessionId>40a1b9b1-959f-47ea-ba43-ef8561c198c8</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>4bfc8216-4d6c-42d9-8025-089de177eda3</d2p1:BulkInsertId> <d2p1:BulkInsertSessionId>40a1b9b1-959f-47ea-ba43-ef8561c198c8</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>