The configuration SOAP API methods enable the retrieval of system
configuration details.
getAddressTypes() SOAP API method
Requests and obtains the details of all configured name
types. The UMF API equivalent of the getNameTypes method
are the SOA_ADDRESS_TYPES_REQUEST input document and the SOA_ADDRESS_TYPES_RESPONSE
output document.
getAlertDispositions() SOAP API method
Requests and obtains the details of all configured alert
dispositions. Client applications will generally call this service
and cache the result for later use in order to lookup address type
details by their code. If a address type code is ever encountered
that is not recognized in the client cache, then this service can
be called again in order to update the lookup table within the client
application. The UMF API equivalent of the getNameTypes method
are the SOA_ALERT_DISPOSITIONS_REQUEST input document and the SOA_ALERT_DISPOSITIONS_RESPONSE
output document.
getCharacteristicTypes() SOAP API method
Requests and obtains the details of all configured characteristic
types. Client applications will generally call this service and cache
the result for later use in order to lookup characteristic type details
by their "internal ID". If a characteristic type ID is ever encountered
that is not recognized in the client cache, then this service can
be called again in order to update the lookup table within the client
application. The UMF API equivalent of the getCharacteristicTypes method
are the SOA_CHARACTERISTIC_TYPES_REQUEST input document and the SOA_CHARACTERISTIC_TYPES_RESPONSE
output document.
getEventTypes() SOAP API method
Obtains details on all configured event types. The UMF
API equivalent of the getEventTypes method are the
SOA_EVENT_TYPES_REQUEST input document and the SOA_EVENT_TYPES_RESPONSE
output document.
getNameTypes() SOAP API method
Requests and obtains the details of all configured name
types. Client applications will generally call this service and cache
the result for later use in order to lookup address type details by
their code. If a address type code is ever encountered that is not
recognized in the client cache, then this service can be called again
in order to update the lookup table within the client application.
The UMF API equivalent of the getNameTypes method
are the SOA_NAME_TYPES_REQUEST input document and the SOA_NAME_TYPES_RESPONSE
output document.
getNumberTypes() SOAP API method
Requests and obtains the details of all configured number
types. Client applications will generally call this service and cache
the result for later use in order to lookup number type details by
their "internal ID". If a number type ID is ever encountered that
is not recognized in the client cache, then this service can be called
again in order to update the lookup table within the client application.
The UMF API equivalent of the getNumberTypes method
are the SOA_NUMBER_TYPES_REQUEST input document and the SOA_NUMBER_TYPES_RESPONSE
output document.
getRoleAlertRules() SOAP API method
Requests and obtains the details of all configured role
alert rules. Client applications will generally call this service
and cache the result for later use in order to lookup role alert rules
by their "internal ID". If a role alert rule ID is ever encountered
that is not recognized in the client cache, then this service can
be called again in order to update the lookup table within the client
application. The UMF API equivalent of the getRoleAlertRules method
are the SOA_ROLE_ALERT_RULES_REQUEST input document and the SOA_ROLE_ALERT_RULES_RESPONSE
output document.
getRoles() SOAP API method
Requests and obtains the details of all configured roles.
Client applications will generally call this service and cache the
result for later use in order to lookup role details by their "internal
ID". If a role ID is ever encountered that is not recognized in the
client cache, then this service can be called again in order to update
the lookup table within the client application. The UMF API equivalent
of the getRoles method are the SOA_ROLES_REQUEST
input document and the SOA_ROLES_RESPONSE output document.