
This file contains brief description about all the API functions used.


**********************************************************************************************************************
										CARRIER ADMINISTRATION API
**********************************************************************************************************************
1. Carrier IntraLATA Agreements (CLA):
-------------------------------------
The Carrier IntraLATA Agreements reference data provides the information regarding the Local Exchange Carriers (LECs) 
and other telecom carriers who may serve as IntraLATA carriers for Toll-Free calls.

2. Carrier IntraLATA Exceptions (CLE):
-------------------------------------
The LECs that want to disallow the use of their local network to certain POTS destination telephone numbers can use 
the Carrier IntraLATA Exceptions (CLE) function for the POTS numbers that are not allowed to be used for routing 
Toll-Free calls by using CIC 0110 code.

3. Approval Exceptions by TFN (EAP):
-----------------------------------
The Exception Approval by TFNs (EAP) screen allows authorized users to define notification exceptions and approval 
exceptions to the General Notification and Approval (GNA) for individual TFNs. The EAP will support both regular CRs
and Pointer Record.

4. Exception Notifications (ENO):
--------------------------------
The ENO allows a CIC to set up notification conditions for a specific DIAL#. These conditions will override the 
conditions specified on the GNA screen.

5. Carrier Agreements (CAG):
---------------------------
Carrier Agreement with Entities allows Carrier entities to define the set of service provider Resp Orgs that will be 
allowed to use their CICs (Carrier Identification Codes) in the Resp Org’s CRs, and thereby route TF traffic through 
their networks.

6. Carrier Information and Security (CIS):
-----------------------------------------
The CIS table defines the set of Carriers and their CICs that may be used in CRs provisioned by the SMS/800 System.

7. Carrier IntraLATA Agreements (CLA):
-------------------------------------
The Carrier IntraLATA Agreements (CLA) reference data provides the information regarding the Local Exchange Carriers 
(LECs) and other telecom carriers who may serve as IntraLATA carriers for Toll-Free calls.

8. Carrier IntraLATA Exceptions (CLE):
-------------------------------------
The LECs that want to disallow the use of their local network to certain POTS destination telephone numbers can use 
the Carrier IntraLATA Exceptions (CLE) function for the POTS numbers that are not allowed to be used for routing 
Toll-Free calls by using CIC 0110 code.

9. Carrier Operating Company Numbers (OCN):
------------------------------------------
The SMS/800 Administrator assigns the Operating Company Number (OCN) codes to a Resp Org Entity code of a LEC. 
The OCN identifies either the ILEC or the CLEC that controls the NPANXX and offers telecom service to its subscriber 
lines.

10. Resp Orgs Allowed Using CIC 0110 (RAC)

11. Resp Orgs Disallowed Using CIC 0110 (RDC)

12. Detail of Carrier Approval Status (DAP):
-------------------------------------------
The Detail of Approval Status (DAP) screen, is used by a Control Resp Org to monitor carrier-approval for their 
Customer Records.

13. Summary of Carrier Approval Status (SAP):
--------------------------------------------
The Summary of Carrier Approval Status (SAP) is used by a Control Resp Org to view detailed carrier approval 
information for a specific Customer Record.



**********************************************************************************************************************
									CUSTOMER RECORD ADMINISTRATION API
**********************************************************************************************************************
1. Customer Administrative Data (CAD):
--------------------------------------
Customer Administrative Data (CAD) portion, which contains administrative data about the toll-free customer and 
their service as well as basic call processing information, such as the originating Area  of Service (AOS), 
a list of one or more destination telephone number(s) and the Carrier Identification Codes (CICs)  for  IntraLATA 
and InterLATA traffic.

2. Mass Carrier Change Information Input(CCI):
----------------------------------------------
The Mass Carrier Change Information (CCI) allows TFN Registry Help Desk users to enter Mass Carrier Change information. 
The tasks that may be completed by TFN Registry Help Desk user.

3. High Priority Customer Record Updates(HPU):
----------------------------------------------
The High Priority Customer Record Updates (HPU) on-line functions allows authorized users to set HPU flag in Customer 
Records. High Priority CR Update capability is applicable for Customer Records with an effective date of “NOW” or 
today’s date.

4. Pointer Administrative Data (PAD):
-------------------------------------
Pointer records are CRs uniquely identified by their TFN and effective date-and-time.Pointer records contain some 
customer administrative data for the toll-free number in a data portion known as Pointer Administrative Data (PAD), 
but unlike regular customer records, the PAD excludes the Area-of-Service (AOS) and Carrier information and 
additionally Template Name is specified in Pointer Records.

5. Resp Org Associated Carrier (ROC):
-------------------------------------
The ROC defines the Carrier Identification Codes (CIC) that are associated with a Carrier’s Resp Org. A Carrier may 
view any customer record (CR) that contains routing information that uses any of the Carrier’s CIC(s) that are 
specified on the Carrier’s ROC screen, except that such Involved Carriers aren’t permitted to view the CPR’s 
terminating numbers or CPR’s CICs of other Carriers.


**********************************************************************************************************************
											GENERAL ADMINISTRATION API
**********************************************************************************************************************
1. Area-of-Service Label Record (ASL): 
--------------------------------------
Resp Org users and TFN Registry Administrators access the Area of Service Label(ASL) functions to create/manage 
Area of Service Labels to be used on Customer records.

2. NPA-NXX_LATA Information (NXL):
----------------------------------
The TFN Registry Administrator uses the NPA-NXX-LATA Information (NXL)function to manage Geographic NPA-NXXs and 
make adjustments based on TPM input.

3. MGI Activation Notice Control (GAN):
---------------------------------------
The TFN Registry Administrator uses the MGI Activation Notice Control (GAN) reference table to specify whether or 
not a Resp Org should receive customer record activation notices and/or customer record failure notices.

4. MGI Unsolicited Notice Control (GUN):
----------------------------------------
The TFN Registry Administrator uses the MGI Unsolicited Notice Control (GUN) reference data table to specify whether 
or not a Resp Org should receive an Unsolicited MGI message via the MGI interface to the Resp Org’s client system.

5. MGI Security Administration (GSA):
-------------------------------------
The TFN Registry Administrator uses the MGI Security Administration (GSA) function to specify new MGI (MGI) Logon IDs 
and to map Resp Orgs to MGI Logon IDs.

6. NPA Code Opening/Overlay (NCO):
----------------------------------
The NPA Code Opening/Overlay Information (NCO) online business function allows authorized TFN Registry users to create 
NPA Code Opening/Overlay information. Resp Org users may view and print the data on the NPA Code Opening/Overlay 
Information (NCO) screen. 

7. System Parameter Handling (SPH):
-----------------------------------
It lists and explains about all the different types of system parameters.
The parameters are Customer Record Parameters, Security Parameters, Number Administration Parameters and Billing Parameters
 

**********************************************************************************************************************
											NUMBER ADMINISTRATION API
**********************************************************************************************************************
1. Reservation Limits (REL):
----------------------------
The System allows the Help Desk User to set number reservation limits which are applicable across the system. 
The system allows the Resp Org User to view the Reservation Limits for their Resp Org Entity.

2. Allowable NPA (AND):
-----------------------
The System provides the information about the list of Toll Free NPAs that are allowable. It also provides provision 
to Add or Delete the allowable Toll Free NPAs. A default Toll Free NPA that needs to be selected for Random Search 
of numbers can also be set.
 
3. Search (NUS):
----------------
The User simply requests that the System identify one or more TFNs (Toll Free numbers) that are in SPARE status. 
The User takes no further action once the System provides a response to the search request and, therefore, 
there is no change to the status of the numbers returned by the search.

4. Search Then Reserve (NUS&R):
-------------------------------
For a Search Then Reserve use case, the User executes a Search and subsequently requests that one or more numbers 
returned in response to the Search be reserved.

5. NXX Usage Control (NUC):
----------------------------
The NXX Usage Control allows administrative users or help desk users to open and close a specific NPA-NXX for 
toll-free service and set the maximum percent of dial numbers that can be randomly searched/reserved for the 
retrieved NPA-NXX. In addition, the current dial number usage of an NPA-NXX can also be viewed

6. Reservation Allocation Control (RMS):
----------------------------------------
The Reservation Allocation Control (RMS) function, along with the Reservation Allocation (WRA) function, supports the 
TFN Registry’s Number Allocation function and supplement the Reservation Limit (REL) function. Number Allocation 
supplements the Reservation Limit (REL) screen.  Number Allocation allows authorized system administrators (such as the
Help Desk) to enter parameters for number reservation per authorization of the Federal Communications Commission (FCC).

7. Reservation Allocation (WRA):
---------------------------------
The Reservation Allocation (WRA) screen, in concert with the Reservation Allocation Control (RMS) screen, supports the 
Toll-Free Number Registry Number Allocation function. Number Allocation supplements the Reservation Limit (REL) screen. 
Number Allocation allows authorized system administrators (such as the Help Desk) to enter parameters for number 
reservation per direction of the Federal Communications Commission (FCC).


**********************************************************************************************************************
										ORGANIZATION ADMINISTRATION API
**********************************************************************************************************************
1. Resp Org Info (ORG):
----------------------–
The Resp Org Info (ORG) table contains all Resp Orgs defined to the system. For each Resp Org, it is used to 
maintain the Resp Org ID, the name of the organization associated with the Resp Org unit, and the Trouble Referral 
Number (telephone number) for all Toll-Free Numbers (TFNs) it controls.

2. Telephone Company Information (TCO):
---------------------------------------
The SMS/800 Telephone Registry Administrator uses the Telephone Companies Information (TCO) reference data table 
to specify new or delete Telephone Companies. The CRA functions use the TCO table to validate that the Company 
Selling SMS/800 Telephone Registry Access (Telco) matches a valid Telco code in the TCO table.

3. Resp Org Report Control (ORC)
--------------------------------

4. Entity Affiliation (EAF):
----------------------------
The TFN Registry Administration Helpdesk users are allowed to access the Entity Affiliation screens to add, update, 
delete and view the entity details


**********************************************************************************************************************
											SCP ADMINISTRATION API
**********************************************************************************************************************

1. CCS Network Information (NET):
---------------------------------
The CCS network may be used for SCP administration and in Area of Service (AoS) definitions for customer records. 
This shall be the initial state when the record is successfully created in the CCS network table.

2. Network Provider-SCP Owner/Operator IntraLATA Agreements (NLA):
------------------------------------------------------------------
Network service providers can restrict the use of their network to specific Resp Orgs by using the Network 
Provider-SCP Owner/Operator IntraLATA Agreements (NLA)function and providing the Resp Orgs that are allowed to use 
their network for routing Toll-Free calls by using CIC 0110 code.

3. Network Provider-SCP Owner/Operator IntraLATA Exceptions (NLE):
------------------------------------------------------------------
Network service providers can restrict the use of their network to certain POTS destination (10 digits or 6 digit 
NPA-NXXs which map to any of their OCNs) that are not allowed to be used for routing Toll-Free calls by using 
CIC 0110 code.

4. Network Allowed Carriers (NAC):
----------------------------------
Network Allowed Carriers (NAC) table is used to identify a subset of CICs that are supported by a CCS network.

5. SCP ID Definition (SID):
---------------------------
SCP ID Definition (SID) is used to define new SCPs to the system by the SMS800 TFN Registry Administrator. 

6. Network Provider-SCP Owner/Operator Company Codes (NCC):
-----------------------------------------------------------
The TFN REGISTRY Administrator uses the Network Provider-SCP Owner/Operator Company Codes (NCC) function to set up 
restrictions for a network service provider for routing across their network using CIC 0110 for Toll-Free customer 
records controlled by other companies.

7. Network Provider-SCP Owner/Operator Carrier Agreements (NCA):
----------------------------------------------------------------
Network service providers can restrict the use of their network to specific LECs by using the Network Provider-SCP 
Owner/Operator Carrier Agreements (NCA) function and providing the OCN codes that are allowed to use their network 
for routing Toll-Free calls by using CIC 0110 code.

8. NPA to CCS Network Mapping (NCN):
------------------------------------
The TFN REGISTRY System maintains NCN reference data table to determine which CCS networks and their SCPs will receive 
customer records for a specified NPA as the area-of-service.
 
9. LATA to CCS Network Mapping (LCN):
-------------------------------------
The TFN Registry Administrator uses the LATA to CCS Network Mapping (LCN) reference data table to establish LATA to 
CCS Network mapping. The TFN Registry System maintains LCN reference data table to determine which CCS networks and 
their SCPs will receive customer records for a specified LATA as the area-of-service.



