Modular+Specs+Metadata+and+Errors

include component="page" wikiName="siframework" page="ModularSpecTabs" =Metadata=

HpdPlusMetadataPropertyName Values

 * ~ Name ||~ Description ||
 * doNotFederate || Hint from the requesting client to not perform federation. Whether the hint is honored is entirely up to the receiving Directory. ||
 * flattenResponse || Hint from the requesting client to return a "flattened" response consisting of a single, collated DSML v2 BatchResponse. The resulting BatchResponse is effectively the result of a similar request if it were dispatched to a Directory implementing the original/IHE HPD(Plus) web service. Whether the hint is honored is entirely up to the receiving Directory. ||

=Errors=

Copied/adapted from DSML v2

 * ~ **Type** ||~ **Description** ||
 * notAttempted || Error dispatched when a connection to another Directory is not to be attempted. ||
 * couldNotConnect || Error dispatched when a connection to another Directory could not be established. ||
 * connectionClosed || Error dispatched when a connection to another Directory was closed prematurely. ||
 * malformedRequest || Error dispatched when a request from a client is malformed (at the web service layer). ||
 * gatewayInternalError || Error dispatched when an internal fault has occurred, preventing the current Directory from responding to a request. ||
 * authenticationFailed || Error dispatched when a client has failed to authenticate (if applicable). ||
 * unresolvableURI || Error dispatched when a connection's URI cannot be resolved. ||
 * other || Error dispatched when no specifically defined error is appropriate. ||

New in the HPD Plus Web Service

 * ~ **Type** ||~ **Description** ||
 * federationLoop || Error dispatched when a loop is detected based upon receipt of a request containing an already outstanding requestID. ||
 * organizationalQueryRulesViolation || Error dispatched when an internal business rule has been violated (implementation/environment-specific). ||