Copyright © tutorialspoint.com
Description: The save_business API call is used to save or update information about a complete businessEntity element.
This API returns a businessDetail message containing the final results of the call that reflects the new registered information for the businessEntity information provided. These results will include any businessServices that are contained by reference. If the same entity determined by matching key, is listed more than once in the save_business message, it may be listed once in the result for each appearance in the save_business message. If so, the last appearance in the results represents the final saved state.
Version 2.0 Syntax:
authInfo: This required argument is an element that contains an authentication token. Authentication tokens are obtained using the get_authToken API call.
businessEntity: One or more complete businessEntity elements can be passed. These elements can be obtained in advance by using the get_businessDetail API call or by any other means.
If any error occurs in processing this API call, a dispositionReport element will be returned to the caller within a SOAP Fault. The following error number information will be relevant:
E_authTokenExpired: signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.
E_authTokenRequired: signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.
E_invalidKeyPassed: signifies that the request cannot be satisfied because one or more uuid_key values specified is not a valid key value. This includes any tModelKey references, as well as references to serviceKey or bindingKey values that either do not exist.
E_invalidProjection: signifies that an attempt was made to save a businessEntity containing a service projection that does not match the businessService being projected. The serviceKey of at least one such businessService will be included in the dispositionReport.
E_userMismatch: signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token. The key causing the error will be clearly indicated in the error text.
E_invalidValue: A value that was passed in a keyValue attribute did not pass validation. This applies to checked categorizations, identifiers and other validated code lists. The error text will clearly indicate the key and value combination that failed validation.
E_requestTimeout: Signifies that the request could not be carried out because a needed validate_values service did not respond in a reasonable amount of time. Details identifying the failing service will be included in the dispositionReport element.
E_valueNotAllowed: Restrictions have been placed by the taxonomy provider on the types of information that should be included at that location within a specific taxonomy. A validate_values service chosen by the Operator Site has rejected this businessEntity for at least one specified category.
E_accountLimitExceeded: signifies that user account limits have been exceeded.
Copyright © tutorialspoint.com