Add Notes
Use this operation to add new Note object.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Notes": {
"Note": {
"Subject": "Note Subject",
"ContactName": "Bob",
"RelatedToType": "SalesOrder",
"RelatedToValue": "1236",
"FileName": "Note.jpg",
"FileType": "image/jpeg",
"AttachmentContent": "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
"CreatedTime": "08-13-2024 12:25:04",
"CreatedTimeUTC": "08-13-2024 06:55:04",
"ModifiedTime": "08-13-2024 12:27:40",
"ModifiedTimeUTC": "08-13-2024 06:57:40",
"Note": "Note content goes here."
}
}
}
<Notes>
<Note>
<Subject>Note Subject</Subject>
<ContactName>Bob</ContactName>
<RelatedToType>SalesOrder</RelatedToType>
<RelatedToValue>1236</RelatedToValue>
<FileName>Note.jpg</FileName>
<FileType>image/jpeg</FileType>
<AttachmentContent>R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==</AttachmentContent>
<CreatedTime>08-13-2024 12:25:04</CreatedTime>
<CreatedTimeUTC>08-13-2024 06:55:04</CreatedTimeUTC>
<ModifiedTime>08-13-2024 12:27:40</ModifiedTime>
<ModifiedTimeUTC>08-13-2024 06:57:40</ModifiedTimeUTC>
<Note>Note content goes here.</Note>
</Note>
</Notes>
Sample Response
{
"MCM": {
"response": {
"objectType": "Notes",
"syncTime": "2024-08-16 07:00:29"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"notes_subject": "Note Subject",
"notes_id": "136512"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Notes</objectType>
<syncTime>2024-08-16 07:00:29</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<notes_subject>Note Subject</notes_subject>
<notes_id>136512</notes_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="UTF-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Notes">
<method name="POST">
<request>
<param name="key" type="xsd:string" style="query" required="true" />
<param name="Subject" type="xsd:int" style="body" required="true" />
<param name="ContactName" type="xsd:String" style="body" />
<param name="RelatedToType" type="xsd:String" style="body" />
<param name="RelatedToValue" type="xsd:String" style="body" />
<param name="FileName" type="xsd:String" style="body" />
<param name="FileType" type="xsd:String" style="body" />
<param name="AttachmentContent" type="xsd:string" style="body" />
<param name="CreatedTime" type="xsd:dateTime" style="body" />
<param name="ModifiedTime" type="xsd:dateTime" style="body" />
<param name="Note" type="xsd:string" style="body" />
<NotesId>36189</NotesId>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet" />
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error" />
</response>
</method>
</resource>
</resources>
</application>
Updated about 20 hours ago