|
Term
|
Unabridged
|
Explanation
|
|
API
|
Application Programming Interface
|
Method for computer systems to exchange data using defined standards and formats
|
|
JSON
|
Java Script Object Notation
|
An open-standard file format that uses human-readable text to transmit data objects
Consists of attribute–value pairs and array data types
|
|
RAML
|
Restful API Modelling Language
|
Used to document API design at Chorus
|
|
PLSAM
|
POTS Line Service Area Master
|
The unique address identifier used within Chorus copper products
|
|
TLC
|
Telecom Location Code
|
The unique address identifier used within Chorus fibre products
|
|
TUI
|
Terralink Unique Identifier
|
The unique address identifier used by Core Logic
|
|
AID
|
Address ID
|
Another unique address identifier used by Core Logic
|
|
HATEOAS
|
Hypermedia As The Engine Of Application State
|
Provides information to navigate the API's interfaces dynamically by including hypermedia links within the responses.
|
|
Auto Complete Logic
|
Auto Complete Logic |
Returns the results JSON array which is a list of matches that the API has determined to be of high relevance, such as an exact match to the requested search term.
Note: No matches will be returned if the postal code is provided as the last token of the search term. A token is defined as a keyword delimited by a whitespace character in this instance.
|
|
Fuzzy Complete Logic
|
Fuzzy Complete Logic |
Performs Auto Complete Logic as its initial step. If the Auto Complete Logic returns less than 11 matches then it will _try_ to retrieve fuzzy matches if any. Fuzzy matches are matches that the API determines as having lower relevance compared to exact matches such as when the search term has misspellings or typos.
Note: No matches will be returned if the postal code is a token of the search term. There will be instances when the results array has less than 11 records and the suggestions array is empty. This just means that the logic has found exact matches and no fuzzy matches were found.
|