Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 594
[Type text] 
 
 
Cisco EPN Manager OSS  Integration  Guide for  MTOSI 
 
 
78 
Technology 
Service 
Service Type 
ELAN 
EP-LAN 
EVP-LAN 
E-Tree 
EP-Tree 
EVP-Tree 
E-Access 
Access EPL 
Access EVPL 
 
4.13.2 Error Message Format with Error Codes 
In Cisco EPN Manager, all the MTOSI APIs return error messages as SOAP Faults. In case of Service Actication 
APIs (Provisioning API), a SOAP fault message contains an additional element to provide more details about 
the error. These details contain the MTOSI specific error elements structure (internalError, 
NotImplementedError, etc) that contains Cisco EPN Manager specific error element to show the error details 
with error code and text message in the vendor extensions as shown below. 
 
<soap:Fault> 
      <faultcode>soap:Server</faultcode> 
      <faultstring>Invalid Port reference for Device ID - TerminationPoint not found with FDN 
[MD=CISCO_EPNM, ME=ASR903-165.68, 
FTP=name=GigabitEthernet0/4/3;LR=LR_ETHERNET]</faultstring> 
      <detail> 
        <ns3:provisionException> 
          <ns3:basicFailureEvent> 
            <ns16:internalError> 
              <ns16:vendorExtensions> 
                <ns27:error> 
                  <ns27:code>MTOSI_0000</ns27:code> 
                  <ns27:message>Invalid Port reference for Device ID - TerminationPoint not found with 
FDN [MD=CISCO_EPNM, ME=ASR903-165.68, 
FTP=name=GigabitEthernet0/4/3;LR=LR_ETHERNET]</ns27:message> 
                </ns27:error> 
              </ns16:vendorExtensions> 
            </ns16:internalError> 
          </ns3:basicFailureEvent> 
        </ns3:provisionException> 
      </detail> 
    </soap:Fault> 
 
The content of the error element in the vendor extensions  has the follow elements for error details: 
 
code - error code to identify the type of error which is a programming interface to the api that can 
be used to further process the error based on the code according to the OSS integration 
requirement. 
 
message - error message that explains the meaning behind the error in basic terms.  
 
In case of provisioning  configuration (cli) deployment failures where the operation response is not a SOAP 
Fault, the error code and message are returned in the deployResult element of the response.