Purpose
In this document, developer MUST noted the different of definition of particular wording.
Here under we'll explain several possible mix definitions used in this document:
- variables = parameters
A parameter or a formal argument, is a special kind of variable, used in a subroutine to refer to one of the pieces of data provided as input to the subroutine.
Variable Type
Sending variable to EHORS' APIs needed to be notice on the variable type as the format required on particular field.
| Variable Type | Format | Descriptions | Sample |
|---|---|---|---|
Date(YYYY-mm-dd) | [Year, 4 Digits]-[Month, 2 digits]-[Day, 2 digits] STRING | Separator by "-" character with year, month and day Year needed to be 4 digits, month in 2 and day in 2 If month and day less than 10, "0" needed to be add in front | 2020-03-17 |
VarChar(X) | STRING, alphanumeric, general text with UTF-8 characters With maximum X numbers characters. | Beware of special characters like ' single quote (apostrophe) " double quote \ Black slash | abc1 22h-as_sdasd1 |
Num(X) | NUMBERS only, only digits are allow, 0 until 9. With maximum X numbers of digits | Only digits are allow, but minus sign are acceptable. | 12353 |
Double(X.Y) | FLOAT numbers with precision, in this case X can be any number. Y represent number of precision support | Floating or double number use for amount, separator between X and Y | 81921.00 |
Text | Text in UTF-8 Format, no text limit, however in Linux server back-end, we d have a 50,000 characters limit per POST variable | And full text | JHVSADUsa hduasdgauyxg |
XML General Reference
Useful link on w3schools => https://www.w3schools.com/xml/dom_nodes.asp
| Symbol | EHORS API Document Field | Example |
|---|---|---|
<abcName>data123<abcName> | #abcName | Node |
<abcName egfAttribute="data123" /> | #abcName@efgAttribute | Node attribute |
| #abcName/xyxName | Sub-element with parent node #abcName |