SearchLocalRec

Name

SearchLocalRec Retrieve information about a toll-free number's records.

Description

SearchLocalRec provides the ability to retrieve certain information in a toll-free number's records. This includes the date/time, status, Area of Service, SMS Template name and list of CICs specified for a record. The search is limited to numbers owned by the API user's company. In addition to information about a number's individual records, a count of records is also provided. The following are the allowed fields in reqparams:

* dn The toll-free number to be queried.

statuslist A comma separated list of 8MS number status values. Setting this parameter limits the search to records in the one or more specified status values. Values should match the status words (case insensitive) shown on the Search Local Record user interface screen. The values include: Active, Disconnect, Hold, Invalid, Old, Pending, Saved, Sending, MustCheck, Failed, Rejected. A default status of Active is set if no statuslist is specified.

latestdate Only return information related to the latest record. Setting latestdate to y will retrieve only the latest record. Setting this param to any other value or not specifying it indicates that all records should be returned.

showcic Setting showcic to 1 indicates that all CICs used in the routing of this number's record should be returned. A list of CICs is returned. Setting this param to any other value or not specifying it indicates that the list of CICs should not be returned.

The timeout parameter, available to all API calls, should not be set to less than 30 seconds for this call since this call does not support retrieving data after a timeout occurs.

MGI Messages

None.

Results

The result of a SearchLocalRec request is represented as an XML document. This XML document will be contained within the <msgparams> tag of the normal 8MS API return structure. For example, the following might be returned from a request:

<msgparams>
<SearchLocalRec>
<RecordsTotal>1</RecordsTotal>
<RecordsReturned>1</RecordsReturned>
<LocalRecords>
<Records>
<Number>855-711-8583</Number>
<DateTime>11/21/11 07:15A</DateTime>
<Status>Active</Status>
<AosLabel><AosLabel>
<AosAreaCode><AosAreaCode>
<AosLata><AosLata>
<AosNetwork>US<AosNetwork>
<AosState><AosState>
<TemplateName><TemplateName>
<CicList>
<Cic>0444</Cic>
<CicList>
<Records>
<LocalRecords>
<SearchLocalRec>
</msgparams>

Example

The following request parameter will request the record date/time and CIC list for the toll-free number in the Active status:

dn~8005551212;statuslist~active;showcic~1

*	dn	The toll-free number to be queried.
	statuslist	A comma separated list of 8MS number status values. Setting this parameter limits the search to records in the one or more specified status values. Values should match the status words (case insensitive) shown on the Search Local Record user interface screen. The values include: Active, Disconnect, Hold, Invalid, Old, Pending, Saved, Sending, MustCheck, Failed, Rejected. A default status of Active is set if no statuslist is specified.
	latestdate	Only return information related to the latest record. Setting latestdate to y will retrieve only the latest record. Setting this param to any other value or not specifying it indicates that all records should be returned.
	showcic	Setting showcic to 1 indicates that all CICs used in the routing of this number's record should be returned. A list of CICs is returned. Setting this param to any other value or not specifying it indicates that the list of CICs should not be returned.