EliNoteService
EliNoteService.asmx
Updated: 11/8/23 for 8.5 and 8.6 Web Services
This web service provides the methods to add, change, delete and list notes in NOTES table.
AddNote
This method creates one or multiple notes depending on user’s input.
Usage:
AddNoteResult = A.Addnote(UserName, UserPassword, AddNoteInput, ExtraInput)
Parameters UserID, Password and ExtraInput are not used at this moment.
AddNoteInput Structure
|
Property Name |
Length |
Type |
Upper |
Detail |
|
FileName |
8 |
String |
Y |
Required. File name must be one of the following: ARCUSFIL, APVENFIL, IMITMFIL, CPORDHDR, CPORDLIN, POORDHDR, BMORDFIL, SFORDFIL, EMPFILE, ARSLMFIL, CPSHPFIL, CPINVHDR, IMLSHST, COMMENT, SYUSRFIL, BMRTGFIL |
|
FileReferenceNumber |
30 |
String |
Y |
Required. |
|
Folder |
10 |
String |
Y |
If value is not provided, it is assumed to be blank. Most of the time, you will leave the folder as blank. |
|
CreateDate |
8 |
Date |
|
If this field is not provided, web service will use system date/time as note create date/time. If user wishes to create a hold order note, set date part as order entry date, and time part as 00:00:00. FileName also must set to “CPORDHDR” for hold order note. If user wishes to append to the existing hold order note, then user should use the ChangeNote method. For hold order note, system does not accept duplication, and it will return an error code if user tries to create a duplicate hold order note. On the other hand, if there is a duplicate key on regular notes, system will add 1 second to note create time until there is not duplication. |
|
NoteType |
6 |
String |
|
If you provide a note type, it must be in NOTETYPE table. |
|
Topic |
30 |
String |
|
|
|
Content1 |
60 |
String |
|
|
|
Content2 |
60 |
String |
|
|
|
Content3 |
60 |
String |
|
|
|
Content4 |
60 |
String |
|
|
|
Content5 |
60 |
String |
|
|
|
Content6 |
60 |
String |
|
|
|
Content7 |
60 |
String |
|
|
|
Content8 |
60 |
String |
|
|
|
Content9 |
60 |
String |
|
|
|
Content10 |
60 |
String |
|
|
|
ElliottUser |
10 |
String |
Y |
If this field has a value, web service will use it as note’s CreatedByUser and ModifyByUser. System will validate the provided users against SYSPASS table in the root directory. If not provided, web service will use default value “WEB-USER” as CreatedByUser and ModifyByUser. |
* Upper = Y indicates the value of the property will be converted to upper case.
AddNoteResult Structure
|
Property Name |
Type |
Detail |
|
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliNoteService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
ExtraOutput |
String |
Not used at the moment |
Code Example (VB)
The following sample codes add two note records. The Input(2) declares there’s two notes to be added. The Input(0) and Input(1) allow you to specify the note records value for record 0 and 1 (it’s zero base).
Dim Service As New webServicesNote.ElinoteService
Dim Input(2) As webServicesNote.AddNoteInput
Dim Result As New webServicesNote.AddNoteResult
Input(0).FileName = “CPORDHDR”
Input(0).FileReferenceNumber = “123456”
Input(0).Topic = “Regular Note”
Input(0).Content1 = “Regular Note by HYC, Date decided by web service”
Input(0).ElliottUser = “HYC”
Input(1).FileName = “CPORDHDR”
Input(1).FileReferenceNumber = “123456”
Input(1).CreateDateTime = New Date(2015,3,3,0,0,0)
Input(1).Topic = “Hold Order Note”
Input(1).Content1 = “Order#123456 has an entry date 3/3/2015”
Input(1).Content2 = “Hold note is manually added”
Result = Service.AddNote(“”,””,Input,””)
If Result.ReturnCode = 0 Then
lblResult.Text = "Notes Created"
Else
lblResult.Text = Result.ReturnMsg
lblReturnCd.Text = Result.ReturnCode.ToString
End If
This method is used to change one or multiple notes. The following properities are key fields to locate the note: FileName, FileReferenceNumber, Folder, CreateDate. These key fields’ values are not changeable.
Usage:
ChangeNoteResult = A.Changenote(UserName, UserPassword, AddNoteInput(), ExtraInput)
Parameters UserID, Password and ExtraInput are not used at this moment.
AddNoteInput Structure
ChangeNote uses AddNoteInput as input data type.
|
Property Name |
Length |
Type |
Upper |
Detail |
|
FileName |
8 |
String |
Y |
Required. File name must be one of the following: ARCUSFIL, APVENFIL, IMITMFIL, CPORDHDR, CPORDLIN, POORDHDR, BMORDFIL, SFORDFIL, EMPFILE, ARSLMFIL, CPSHPFIL, CPINVHDR, IMLSHST, COMMENT, SYUSRFIL, BMRTGFIL |
|
FileReferenceNumber |
30 |
String |
Y |
Required. |
|
Folder |
10 |
String |
Y |
Most of the time, Folder in Note table has blank value. If you do not provide this value, then it is assumed to be blank. |
|
CreateDate |
|
Date |
|
Required. This the create date and create time of the note. |
|
NoteType |
6 |
String |
|
If you provide a note type, it must be in NOTETYPE table. If you do not provide note type (null), system leaves the existing note type unchanged. If you want to change existing note type to blank value, you should provide a space to this field. |
|
Topic |
30 |
String |
|
If you do not provide topic (null), system leaves the existing topic unchanged. If you want to change existing topic to blank value, you should provide a space to this field. |
|
Content1 |
60 |
String |
|
Content 1 – 10 is considered as a group. If you provide value to any field from Content 1 – 10, then system assumes you wish to change all 10 fields. Any field of Content 1 – 10 is not provided (null value) is considered blank. However, if you leave all fields of Content1 – 10 as null, then the Content 1 – 10 will not be updated. |
|
Content2 |
60 |
String |
|
|
|
Content3 |
60 |
String |
|
|
|
Content4 |
60 |
String |
|
|
|
Content5 |
60 |
String |
|
|
|
Content6 |
60 |
String |
|
|
|
Content7 |
60 |
String |
|
|
|
Content8 |
60 |
String |
|
|
|
Content9 |
60 |
String |
|
|
|
Content10 |
60 |
String |
|
|
|
ElliottUser |
10 |
String |
Y |
If this field has a value, web service will use it as note’s ModifyByUser. System will validate the provided users against SYSPASS table in the root directory. If not provided, web service will use default value “WEB-USER” as ModifyByUser. |
* Upper = Y indicates the value of the property will be converted to upper case.
ChangeNoteResult Structure
|
Property Name |
Type |
Detail |
|
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliNoteService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
ExtraOutput |
String |
Not used at the moment |
Code
Example (VB)
The following sample codes will locate the note of order# 123456 created on 3/9/2015, then change note topic, content1 and user of the note.
Dim Service As New webServicesNote.ElinoteService
Dim Input(0) As webServicesNote.AddNoteInput
Dim Result As New webServicesNote.ChangeNoteResult
Input(0).FileName = “CPORDHDR”
Input(0).FileReferenceNumber = “123456”
Input(0).Folder = “ ”
Input(0).CreateDateTime = New Date(2015,3,9,12,15,10)
Input(0).Topic = “Modified Regular Note”
Input(0).Content1 = “Regular Note Modified by User 001”
Input(0).ElliottUser = “001”
Result = Service.ChangeNote(“”,””,Input,””)
If Result.ReturnCode = 0 Then
lblResult.Text = "Note Changed"
Else
lblResult.Text = Result.ReturnMsg
lblReturnCd.Text = Result.ReturnCode.ToString
End If
This method deletes one or multiple notes that match input conditions.
Usage:
DeleteNoteResult = A.Deletenote(UserName, UserPassword, DeleteNoteInput(), ExtraInput)
Parameters UserID, Password and ExtraInput are not used at this moment.
DeleteNoteInput Structure
|
Property Name |
Length |
Type |
Upper |
Detail |
|
FileName |
8 |
String |
Y |
Required. File name must be one of the following: ARCUSFIL, APVENFIL, IMITMFIL, CPORDHDR, POORDHDR, BMORDFIL, SFORDFIL, EMPFILE, ARSLMFIL, CPSHPFIL, CPINVHDR, IMLSHST, COMMENT, SYUSRFIL, BMRTGFIL |
|
FileReferenceNumber |
30 |
String |
Y |
Required. |
|
Folder |
10 |
String |
Y |
If this field is not provided, web service will delete all notes that match FileName, FileRefferenceNumber and CreateDate. If user wants to delete only notes in empty folder, a space must be set to this field. |
|
CreateDate |
|
Date |
|
Note create date and time. If not provided, web service will delete all notes that match FileName, FileRefferenceNumber and Folder. |
|
ElliottUser |
10 |
String |
Y |
Not being used at the moment. In the future, we might introduce security related features that need a user id. |
* Upper = Y indicates the value of the property will be converted to upper case.
DeleteNoteResult Structure
|
Property Name |
Type |
Detail |
|
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliNoteService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
ExtraOutput |
String |
Not used at the moment |
Code Example (VB)
The following example codes will delete all notes for order# 123456 and customer# 555666.
Dim Service As New webServicesNote.ElinoteService
Dim Input(1) As webServicesNote.DeleteNoteInput
Dim Result As New webServicesNote.DeleteNoteResult
Input(0) = New webServicesNote.DeleteNoteInput
Input(1) = New webServicesNote.DeleteNoteInput
Input(0).FileName = “CPORDHDR”
Input(0).FileReferenceNumber = “123456”
Input(1).FileName = “ARCUSFIL”
Input(1).FileReferenceNumber = “555666”
Result = Service.DeleteNote("", "", Input, "")
If Result.ReturnCode = 0 Then
lblResult.Text = "Note Deleted"
Else
lblResult.Text = Result.ReturnMsg
lblReturnCd.Text = Result.ReturnCode.ToString
End If
ListNote
This method lists all notes for the FileName and FileREfferenceNumber.
Usage:
ListNoteResult = A.Listnote(UserName, UserPassword, ListNoteInput, ExtraInput)
Parameters UserID, Password and ExtraInput are not used at this moment.
ListNoteInput Structure
|
Property Name |
Length |
Type |
Upper |
Detail |
|
FileName |
8 |
String |
Y |
Required. File name must be one of the following: ARCUSFIL, APVENFIL, IMITMFIL, CPORDHDR, POORDHDR, BMORDFIL, SFORDFIL, EMPFILE, ARSLMFIL, CPSHPFIL, CPINVHDR, IMLSHST, COMMENT, SYUSRFIL, BMRTGFIL |
|
FileReferenceNumber |
30 |
String |
Y |
Required. |
* Upper = Y indicates the value of the property will be converted to upper case.
ListNoteResult Structure
|
Property Name |
Type |
Detail |
|
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “EliNoteService Return Code” section. |
|
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
|
NoteRecord() |
noteRecord |
This noteRecord structure contains the following properties: Topic Folder NoteType FileName FileReferenceNumber CreateDate CreatedByUser ModifyDate ModifyByUser Content1 Content2 Content3 Content4 Content5 Content6 Content7 Content8 Content9 Content10 ContentCR1 ContentCR2 ContentCR3 ContentCR4 ContentCR5 ContentCR6 ContentCR7 ContentCR8 ContentCR9 ContentCR10 TaskStatus FollowUpByUser FollowUpDate ReadableFlag ChangeableFlag DeleteableFlag OrigFollowUpDate TimesFollowUpDateChg EstimatedTime RemindDate RecurType RecurFrequency RemindAheadType RemindAheadValue Continued |
|
NoOfListResult |
Integer |
Number of records in NoteRecord array. |
|
ExtraOutput |
String |
Not used at the moment. |
Code Example (VB)
The following sample codes will list all note records for order# 123456.
Dim Service As New webServicesNote.ElinoteService
Dim Input As New webServicesNote.ListNoteInput
Dim Result As New webServicesNote.ListNoteResult
Input.FileName = “CPORDHDR”
Input.FileReferenceNumber = “123456”
Result = Service.ListNote(“”,””,Input,””)
If Result.ReturnCode = 0 Then
If Result.NoOfListResult = 0 Then
lblResult.Text = "No Record Found"
Else
lblResult.Text = Result.NoteRecord(0).Topic & ", " & _
Result.NoteRecord(0).Content1
End If
Else
lblResult.Text = Result.ReturnMsg
lblReturnCd.Text = Result.ReturnCode.ToString
End If
Supported Note Tables:
At this moment, we support adding notes for the following master tables:
- ARCUSFIL
- APVENFIL
- IMITMFIL
- CPORDHDR
- CPORDLIN - support added on 11/8/2023
- POORDHDR
- BMORDFIL
- SFORDFIL
- EMPFILE
- ARSLMFIL
- CPSHPFIL
- CPINVHDR
- IMLSHST
- COMMENT
- SYUSRFIL
- BMRTGFIL
0 = OK
1 = File
Error
2 =
Invalid Reference Number (AddNote, ChangeNote, DeleteNote, ListNote)
3 = Note
Already On File (AddNote)
4 = Order
No. Not On File (AddNote, ChangeNote)
5 =
Invalid Note Type (AddNote, ChangeNote)
6 = Length
Of Note Content + Note Literal Is Greater Than 60 (AddNote, ChangeNote)
7 = Note
Not On File (ChangeNote, DeleteNote)
8 =
Invalid ElliottUser (AddNotem ChangeNote)
9 =
Invalid File Name (AddNote, ChangeNote, DeleteNote, ListNote) - see section "Support Note Tables"
10 = Line Item Not On File (AddNote, ChangeNote)
CLS