For example, examine the following syntax:
sample_msg(field1 #, field2 #, [field3 <yes/no>], field4 <0..255>)
If you want to omit the field3 parameter of a request, you might enter the request command using
the following syntax:
sample_msg(field1 123, field2 456, field4 128)
Common Response Format
Responses use the same basic format.
If an integer identification (iid) was provided in the request, the response iid corresponds to the
iid of the original request. A return code indicates either success (zero) or failure (non-zero). See
PDBI Message Error Codes, for a mapping between the return code labels described in this section and
the real integer value.
Additionally, an optional data element returns request-specific return information.
Each defined response declares the errors it returns (with their meanings) and what the data section
should look like for each error. If a response does not require a data section (meaning it is just a simple
ACK or NAK), the data section does not appear at all. In that case, the last item in the response is the
return code (rc).
The following example shows the syntax of the common response format. This format applies to all
response messages described in this chapter unless stated otherwise.
rsp ([iid <iid from request>,] rc <return code>, [data (. . .)])
The format of each command response is shown in this chapter. The response information for each
command is described in detail in the Commands Manual.
Number Prefixes
The PDBA has the concept of default number prefixes. These are PDBA parameters that are configurable
from the EPAP Administration Manual. There are two number prefixes, one for DNs and DN Blocks
and the other for IMSIs. They are completely separate and can be set or not set independently. When
set, the number prefix values are automatically prepended to all DNs and DN Blocks or IMSIs
(depending on the prefix type) in PDBI requests. The values are also stripped off of the DNs, DN
Blocks and IMSIs in PDBI responses.
For example, if the DN Prefix is set to “34” in the UI and then an ent_sub request is sent to create
DN 12345, the actual DN stored in the database and sent to the EAGLE 5 ISS is “3412345”. If a PDBI
query is done for DN “12345” while the number prefix is still “34”, the “3412345” is found in the
database, but only the DN value “12345” is returned in the PDBI response.
It is possible to override a default number prefix. The symbol ‘#’ at the beginning of a DN, DN Block,
or IMSI means that it is the actual value and that no number prefix should be applied. This can occur
in both requests and responses.
For example, if the PDBI client sends a value “#12345” in a request, it means that he literally means
the value “12345”, not “3412345” (assuming that “34” is the that type's number prefix). If a PDBI
response comes back with a “#12345”, it means that the DN, DN Block or IMSI literally had the value
“12345”, not “3412345” (still assuming that “34” is the Number Prefix). A response with a “#” value
is returned if a DN, DN Block or IMSI is found in the database that did not match its type's number
prefix.
49
910-6022-001 Revision A, March 2011
PDBI Request/Response MessagesProvisioning Database Interface Manual
To Next Page
Loading...
