ECHO 9.0 Error Codes

This documentation includes the error codes grouped by the service that most commonly uses the code. Services may share error codes, but in most cases the error codes are only used in the owning service. The description of the error code provides information related to when the error code may be used within ECHO. Deprecated error codes may still be used, however they will not be used in new ECHO features that are developed after the error code is deprecated. The fault will contain a more detailed message when the error is raised that contains information about the exact instance of the fault.

Access Control Error Codes

Error Code Description
AccessControlEntryInvalid

Indicates that the access control entry is invalid. Normally this occurs when an invalid granted authority GUID or an invalid permission was supplied.

AccessControlExists

Indicates that an access control list already exists with the same object identity.

AccessControlListNotFound

Indicates that an access control list could not be found. Normally this occurs if the guid is invalid, or if the caller does not have permission for the requested ACL.

CatalogItemIdNotFound

Indicates that a catalog item identity could not be found. Normally this occurs if the guid is invalid, or if the caller does not have permission for the requested ACL.

InsufficientPermissions

Indicates that a a user does not have the necessary permissions to perform the requested action. Normally this occurs when a user is not a member of the correct group or a group does not have the correct ACL configuration in ECHO.

ObjectIdentityInvalid

Indicates that the object identity is invalid. Normally this occurs when an invalid target GUID was supplied.

Authentication Error Codes

All error codes related to user authentication. Authentication includes the act of verifying a user's credentials in the system.

Error Code Description
AdminCanOnlyActAsAnotherUser

Indicates that a user without an administrator role attempted to act as another user. Only ECHO Administrators (users with an administrator role) can act as another user.

ClientIdRequired

Indicates that the client id provided is not valid. This could be because the client id was not specified or the fields in the client id do not meet the field requirements.

GuestCannotActAsAnotherUserOrProvider

Indicates that a guest user attempted to act as a user or on behalf of a provider. Guest users are never permitted to act as a user or on behalf of a provider.

TokenNotFound

Indicates that the given token does not exist or the token is now expired.

UsernameOrPasswordInvalid

Indicates that the user name or password were invalid or not found. For security reasons, ECHO will not indicate that a given user name exists even if only the password is invalid.

UserIpRequired

Indicates that the user IP address provided is not valid or is missing.

Authorization Error Codes

All error codes related to user authorization. Authorization includes the act of verifying that a user has permission to perform some action in the system. Normally permissions are controlled via roles, such as administrator and provider roles, as well as user type, guest or registered.

Error Code Description
NotAdminOrProvider

Indicates that the user is not an administrator nor acting on behalf of a provider. Some operations are limited to only administrators or users acting on behalf of a provider.

NotAnAdministrator

Indicates that the user does not have the ECHO Administrator role and the operation requested is limited to only ECHO Administrators.

NotADataProvider

Indicates that the user is not acting on behalf of a data provider and the operation requested is limited to only registered users acting on behalf of a data provider.

NotAProvider

Indicates that the user is not acting on behalf of a provider and the operation requested is limited to only registered users acting on behalf of a provider.

NotARegisteredUser

Indicates that the user is not a registered user and the operation requested is limited to only registered users.

NotAServiceProvider

Indicates that the user is not acting on behalf of a service provider and the operation requested is limited to only registered users acting on behalf of a service provider.

Calendar Error Codes

Error Code Description
CalendarEventExists

CalendarEventNotFound

Indicates that the calendar event that is referenced does not exist.

Catalog Error Codes

Error Code Description
CatalogItemExists

CatalogItemGuidInvalid

CatalogItemIdDoesNotMatchExisting

CatalogItemNotFound

CatalogItemNotOrderable

CollectionsOrGranulesOnly

This error code indicates that collections and granules were attempted in a single operation that can handle one or the other but not both.

CollectionIdsNotFound

EchoUriNotParsable

Indicates that an ECHO URI in an invocation request was not valid. Please refer to the API documentation for information on ECHO URIs.

GranuleIdsNotFound

MetadataAttributeInvalidForCollections

Indicates that a metadata attribute is not valid for the result type of collections. Collections and granules support a different set of valid metadata attributes.

MetadataAttributeInvalidForGranules

Indicates that a metadata attribute is not valid for the result type of granules. Collections and granules support a different set of valid metadata attributes.

QueryDataCenterIdInvalid

QueryDateRangeInvalid

QueryDateTimeRangeInvalid

QueryMaxConditionsExceeded

Indicates that the number of conditions in a query was larger than the maximum supported even after optimization. It is recommended that the query be split into multiple, smaller queries.

QuerySpatialTypeInvalid

QuerySpatialWindowInvalid

Use this when we are not sure exactly what is wrong, like if Oracle returns an error when validating a spatial window.

QuerySpatialWindowInvalidSpatialPointExceedsLimits

Spatial window points exceeds long/lat limits

QueryTimeRangeInvalid

QueryValidationFailed

Use this when we don't have a specific reason for failure, but it is a client caused error. e.g. SAXException that returns an error message

ResultSetNotFound

UserQueryOwnerMismatch

Data Management Error Codes

All error codes related to provider data management. Data management includes the creation and assignment of order options as well as viewing catalog information for reconciliation.

Error Code Description
ComparatorForBooleanConditionInvalid

Indicates that the comparator selected for the boolean condition is invalid. Boolean conditions only support a subset of the possible comparators. Refer to the API documentation for details.

ComparatorForRegisteredUserConditionInvalid

Indicates that the comparator selected for the registered user condition is invalid. Registered user conditions only support a subset of the possible comparators. Refer to the API documentation for details.

ComparatorForRollingTemporalConditionInvalid

Indicates that the comparator selected for the boolean condition is invalid. Boolean conditions only support a subset of the possible comparators. Refer to the API documentation for details.

ComparatorForTemporalConditionInvalid

Indicates that the comparator selected for the temporal condition is invalid. Temporal conditions only support a subset of the possible comparators. Refer to the API documentation for details.

DataAccessRuleNameExists

Indicates that a rule with the same name already exists for the provider. The rule names must be unique for all rules owned by a provider.

DataAccessRuleNotFound

Indicates that the requested rule could not be found. This means the rule either does not exist or it is not owned by the provider requesting it.

DataQualitySummaryAssignmentNotFound

DataQualitySummaryDefinitionBadHtml

DataQualitySummaryDefinitionExists

DataQualitySummaryDefinitionNotFound

DataQualitySummaryDefRemoveWithDependents

EchoFormAutopopulateExtInvalid

Indicates that an auto-populate extension in an ECHO Form is not valid. The auto-populate extension must conform to the schema and properly reference elements in the ECHO Form model instance.

OptionAssignmentInvalid

Indicates that the assignment of the option definition is not valid. This normally occurs because the catalog items being assigned to are not collections. Option definitions may only be assigned to collections.

OptionAssignmentNotFound

Indicates that an option assignment is not found or is not owned by the current provider.

OrderOptionDefRemoveError

Indicates that an option definition could not be removed. This normally occurs because the definition has dependent definitions (other definitions that import the ECHO Form in this definition) or the definition is still assigned to a catalog item.

RestrictionDataAccessRuleWithGroupIdUnsupported

Indicates that a group was specified when creating a data access rule while the rule was set to be a restriction. Restriction data access rules do not support groups because they apply to all users. Only permission data access rules support groups.

RollingTemporalConditionDurationExceedsMaxLimit

Indicates that the rolling temporal condition duration is longer than the maximum allowed in ECHO. ECHO has a maximum duration to prevent erroneous dates, however that duration is normally very large.

TemporalStartDateNotBeforeStopDate

Indicates that the temporal range start date occurs after the stop date. This creates a range in which no dates could ever fall. Therefore the start date must be before the stop date.

TemporalTypeForRollingTemporalConditionOnCollectionsInvalid

Indicates that a temporal type used in the creation of a data rule is not valid because the rule is for collections. This normally occurs if the temporal type selected is not present on a collection.

TemporalTypeForTemporalConditionOnCollectionsInvalid

Indicates that a temporal type used in the creation of a data rule is not valid because the rule is for collections. This normally occurs if the temporal type selected is not present on a collection.

Event Subscription Error Codes

All error codes related to event notification subscriptions. Event notification subscriptions are used by clients that wish to receive notifications to internal ECHO events such as catalog, provider, or extended services changes.

Error Code Description
EchoEventSubscriptionCountLimitExceeded

Indicates that the maximum number of event subscriptions has been reached in ECHO and ECHO can no longer accept new subscriptions. ECHO Operations will be automatically notified when this error occurs, however if the problem is not resolved ECHO Operations should be contacted directly.

EndpointUnreachable

Indicates that the endpoint of the subscription could not be reached for event delivery. Any events that have occurred will not be delivered. ECHO will continue trying the endpoint for future events.

EventSubscriptionNotFound

Indicates that an event subscription was not found or the user does not have permission to access the subscription.

Extended Services Error Codes

All error codes related to extended services and taxonomies. Extended services are services which are hosted outside of ECHO by service providers and are registered with ECHO for discovery. Taxonomies are used to classify these services for searching.

Error Code Description
ParentEntryTaxonomyNotSame

Indicates that the taxonomy UUID of the new taxonomy entry does not match the taxonomy UUID of the parent entry. The taxonomy UUIDs must match when adding an entry as a child of an existing entry.

QnameUnrecognized

Indicates that an unsupported schema type was found.

ServiceAdvertisementNotActive

Indicates that the web service advertisement is not active and the requested operation cannot be completed. ECHO Operations must activate all web services before they can be accessed.

ServiceAdvertisementNotFound

Indicates that the requested web service advertisement could not be found or it is not owned by the requesting user.

ServiceAdvertisementUpdateAccessDenied

Indicates that the provider does not have access to update the given web service advertisement. Providers can only update web services that they own.

ServiceGuiNotActive

Indicates that the web service GUI is not active and the requested operation cannot be completed. ECHO Operations must activate all web services before they can be accessed.

ServiceGuiNotFound

Indicates that the requested web service GUI could not be found or it is not owned by the requesting user.

ServiceGuiUpdateAccessDenied

Indicates that the provider does not have access to update the given web service GUI. Providers can only update web services that they own.

ServiceImplementationNotActive

Indicates that the web service implementation is not active and the requested operation cannot be completed. ECHO Operations must activate all web services before they can be accessed.

ServiceImplementationNotFound

Indicates that the requested web service implementation could not be found or it is not owned by the requesting user.

ServiceImplementationUpdateAccessDenied

Indicates that the provider does not have access to update the given web service implementation. Providers can only update web services that they own.

ServiceInterfaceInUse

Indicates that an attempt was made to remove an interface for which there are dependent implementations registered with ECHO. Interfaces can only be removed when there are no more dependent implementations.

ServiceInterfaceNotActive

Indicates that the web service interface is not active and the requested operation cannot be completed. ECHO Operations must activate all web services before they can be accessed.

ServiceInterfaceNotFound

Indicates that the requested web service interface could not be found or it is not owned by the requesting user.

ServiceInterfaceUpdateAccessDenied

Indicates that the provider does not have access to update the given web service interface. Providers can only update web services that they own.

TaxonomyEntryExists

Indicates that the taxonomy entry already exists in the taxonomy. Taxonomy entries must be unique within a taxonomy.

TaxonomyEntryNotFound

Indicates that the requested taxonomy entry does not exist. This could occur if the taxonomy UUID given was incorrect and pointed to a different taxonomy.

TaxonomyNotFound

Indicates that the taxonomy requested does not exist.

TaxonomyUuidExists

Indicates that the given taxonomy UUID already exists. Taxonomy UUIDs must be unique.

VirtualTaxonomyAddEntryDenied

Indicates that an attempt to add a virtual taxonomy was denied. Only ECHO Administrators may create virtual taxonomies.

WsdlBindingElementMissing

Indicates that a service interface WSDL is specified without binding element. All web service interfaces must have a binding definition.

WsdlServiceDescriptionError

Indicates that the documentation element on the WSDL service could not be properly extracted. This normally occurs if the service definition is invalid.

WsdlServiceElementInvalid

Indicates that a service interface WSDL has a service element. Only implementations are allowed to have service elements.

WsdlServiceElementMissing

Indicates that a service implementation WSDL was specified without a service element. All web service implementations must have a service definition.

WsdlServiceElementPortAddressMissing

Indicates that a service implementation WSDL was specified without a port address element. All web service implementations must have a port address which specifies the endpoint of the service.

WsdlServiceEndPointMissing

Indicates that a service implementation WSDL was specified without a endpoint element. All web service implementations must have the endpoint of the service.

WsdlServiceNameDoesNotMatchEchoServiceName

Indicates that an update was attempted, however the service name in the WSDL does not match the current service name in the web service interface already registered in ECHO. A change in the service name indicates that the WSDL has been modified outside of ECHO, which is not permitted.

WsdlServiceOperationDescriptionError

Indicates that the documentation element on a WSDL operation could not be properly extracted. This normally occurs if the operation definition is invalid.

WsdlSymbolTableParseError

Indicates that the WSDL was not valid and could be properly parsed. This normally occurs when the symbol table is invalid which means types are referenced in the WSDL that are not definied.

WsdlUrlDoesNotMatchExisting

Indicates that an update was attempted, however the WSDL URL in the new object does match the URL in the current object. When performing an update on a web service interface, the WSDL URL cannot be changed.

WsdlUrlInvalid

Indicates that the web service implementation or interface WSDL could not be retrieved from the given location.

General Error Codes

All error codes that are used across all of ECHO. These error codes are not specific to any service or group of services.

Error Code Description
ArchiveRecordNotFound

Indicates that an archive record could not be found or the user does not have permission to access the record.

AuditActionsInvalid

Indicates that audit actions were not valid for the requested operation.

CountInvalid

Indicates that the number of items in an array field is not valid and does not meet the requirements of the field.

DateTimeStringInvalidFormat

Indicates that date/time information in string form could not be parsed. Normally this occurs because of a format problem with the date/time string.

EmailInvalid

Indicates that the given email address is not in a proper format and is not recognized as an email address.

ErrorCodeNotFound

Indicates that an error code could not be found. This normally indicates that no message has been set for the error code or the code is invalid.

FeatureNoLongerSupported

Indicates that the feature or operation requested is no longer supported. This normally occurs when an older API is used to contact a newer version of ECHO and the specific operation cannot be mapped to the new API. Upgrading to the latest API is the best solution to this type of error.

FtpPushFailed

Indicates that an attempt to push FTP data to a remote server failed. The fault will contain specific information about the failure.

FtpUrlInvalid

Indicates that the URL is not in a valid format to support FTP. FTP URLs must begin with ftp:// and be in a proper format to support user name and password specification. Refer to the API documentation for the specific format.

HttpUrlInvalid

Indicates that the given HTTP URL is not in a valid format. HTTP URLs must start with http://. Please refer to the API documentation for more information.

InternalError

Indicates that an error occurred internally to ECHO while it was processing the request. Internal errors indicate a system problem and that there is nothing wrong with the information provided by the client. In most cases, internal errors indicate that ECHO Operations must be notified with a description of what was happening at the time of the error. The error id can be used to help Operations location the problem in the ECHO logs.

LengthInvalid

Indicates that the length of a string field is not valid and does not meet the requirements of the field.

MiddleInitialInvalid

Indicates that the given middle initial is not valid based on the rules applied to the middle initial. Refer to the API documentation for the specific requirements of a middle initial.

OneValueRequired

Indicates that at least one parameter/field of a set must be specified. The argument information in the fault will list of the names of all parameter/field in the set.

TextPatternStringInvalid

Indicates that a text pattern string given was not valid.

Unknown

Unknown Error - To be used only for stub code and deprecated code. All unknown error types will be removed before the system is operational.

Deprecated: This error code should not occur on a client and is only used for internal development and testing.

ValueMustNotBeSet

Indicates a value must not be provided. This normally occurs when a value must be null or empty but a value was sent from the client.

ValueNotUnique

Indicates a value is not unique.

ValueRequired

Indicates a value was required and was not provided. This normally occurs when a null or empty value is sent from the client.

ValueTooLarge

Indicates that a value was too large and does not meet the requirements of the field.

ValueTooSmall

Indicates that a value was too small and does not meet the requirements of the field.

XpathInvalid

Indicates that the given XPath is invalid. XPaths must conform to the published W3C specification and properly honor all namespaces. Please refer to the specifications for more information.

Group Error Codes

All error codes related to groups and group management. Groups are normally used by providers to send messages to users or to place restrictions and permissions on data using data access rules.

Error Code Description
GroupCreateProhibited

Indicates that a group could not be created. This normally indicates that the group is a reserved being managed by ECHO.

GroupInUse

Indicates that a group cannot be updated in the manner suggested. One case for this exists at time of coding. You cannot change the parent provider of a group once it has been created.

GroupNameExists

Indicates that a group with the given name already exists. Group names must be unique across the entire system.

GroupNotFound

Indicates that a group could not be found. This normally indicates that the group does not exist or the user does not have permission to access the group.

GroupUpdateProhibited

Indicates that a group could not be updated. This normally indicates that the group is a reserved being managed by ECHO.

NotAGroupManager

Indicates that the user is not a group manager and therefore does not have permission to complete the operation requested. Group management operations are limited to specified group managers.

Metric Error Codes

All error codes related to ECHO system metrics. Metrics are used to monitor the system and record usage information.

Error Code Description
MetricReportYearMonthInvalid

Indicates that a year/month combination is invalid. This can occur if the year or month are out of range or if the year and month is after the current year and month.

Option Error Codes

All error codes related to options. Options are used for item ordering and order authenticators. An option definition contains an ECHO Form and a selection contains the users response to the form.

Error Code Description
EchoFormDefinitionInvalid

Indicates that the definition is not valid. Normally this occurs when the ECHO Form does not validate against the ECHO Form XML Schema or the form does not follow the ECHO Forms specification.

EchoFormSelectionInvalid

Indicates that the selection is not valid based on the form that the selection is for. An invalid selection normally indicates that the client application incorrectly handled the ECHO Form processing.

OptionDefinitionSortKeyInvalid

Indicates that the sort key for an option definition is invalid.

OptionDefAlreadyDeprecated

Indicates that an option definition has already been marked as deprecated and therefore cannot be marked as deprecated again. Normally this occurs when a provider attempts to mark a deprecated option as deprecated for a second time.

OptionDefNotFound

Indicates that an option definition could not be found or the user does not have access to the definition.

OptionNameAlreadyUsed

Indicates that an option definition name is already in used by another option. The names of option definitions owned by a single provider must be unique.

Order Error Codes

Error codes related to ordering.

Error Code Description
CancelOrderNotSupported

Indicates that the provider does not support cancelling an order. A provider may optionally support cancelling an order. If programmatic cancelling is not supported, the provider must be contacted directly to determine if an order can be cancelled.

OrderBillingAddressMissing

Indicates that the user's billing address is missing for the order. All required user information must be set on an order for many operations such as quoting and submitting the order. The order will not be considered valid if it is missing required address fields.

OrderContactAddressMissing

Indicates that the user's contact address is missing for the order. All required user information must be set on an order for many operations such as quoting and submitting the order. The order will not be considered valid if it is missing required address fields.

OrderItemAddDenied

Indicates that order items cannot be added while the order is in the current state. Order items can only be added while the order is in a state that allows for editing of the order.

OrderItemExists

Indicates that an order item with the same catalog item guid already exists in the order. Order items must contain unique catalog item guids unless the specific provider supports duplicate catalog items in a single order.

OrderItemNotFound

Indicates that the order item could not be found. Normally this occurs when an order item for the requested guid does not exist in the order.

OrderItemQuantityExceeded

Indicates that the order item being added would push the order over the maximum allowed quantity of order items for the provider. Each provider may have a different configured maximum.

OrderItemRemoveDenied

Indicates that order items cannot be removed while the order is in the current state. Order items can only be removed while the order is in a state that allows for editing of the order.

OrderItemStateChangeDenied

Indicates that order items cannot change state from its current state to the requested new state. Orders must follow a strict state flow and cannot change states arbitrarily.

OrderItemUpdateDenied

Indicates that order items cannot be updated while the order is in the current state. Order items can only be updated while the order is in a state that allows for editing of the order.

OrderNotFound

Indicates that the order requested cannot be found. This normally occurs when an order has been deleted, the user does not have permission to view the order, or the order requested does not exist.

OrderOptionSelectionsMissing

Indicates that one or more of the order items in the order require an option selection for an order option definition but the selection has not been set. Many data providers require option selections in order to process the order.

OrderProviderOrderMissing

Indicates that the order does not contain any provider orders. Provider orders must exist in an order for many operations such as quoting and submitting the order. The order will not be considered valid if it is missing provider orders. Provider orders are automatically created when a catalog item is added for a provider.

OrderShippingAddressMissing

Indicates that the user's shipping address is missing for the order. All required user information must be set on an order for many operations such as quoting and submitting the order. The order will not be considered valid if it is missing required address fields.

OrderTransmissionCommFailure

Indicates that an order cannot be transmitted to the provider in a submit, cancel, or quote request because of a communication failure, such as the provider's endpoint can't be reached. ECHO Operations will need to be contacted to ensure that the provider is properly configured and accepting orders.

OrderTransmissionFailure

Indicates that an order cannot be transmitted to the provider in a submit, cancel, or quote request and the cause is not communication related. The failure may be caused by an application error on the provider's end. If this error persists, ECHO Operations may need to be contacted to ensure that the provider is properly configured and accepting orders.

OrderUserDomainMissing

Indicates that the user domain was not set when it was required. This can occur if the user domain is null when required or set to UNSPECIFIED when that is not a legal value. Normally the user domain of an order is checked during order validation.

OrderUserRegionMissing

Indicates that the user region was not set when it was required. This can occur if the user region is null when required or set to UNSPECIFIED when that is not a legal value. Normally the user region of an order is checked during order validation.

ProviderOrderNotFound

Indicates that the provider order cannot be found. Normally this occurs when the caller does not have permission to view the provider order or the provider order does not exist in the order. A provider order is automatically removed if all catalog items for the provider are removed from the order.

ProviderOrderResubmitDenied

Indicates that the provider order cannot be resubmitted. Provider orders can only be resubmitted in certain states.

ProviderOrderStateChangeDenied

Indicates that the provider order cannot change state from its current state to the requested new state. Provider orders must follow a strict state flow and cannot change states arbitrarily.

ProviderTrackingIdExists

Indicates that the provider tracking id is already used for another provider order for the provider. Provider tracking ids must be unique for all orders for the provider.

Provider Error Codes

All error codes related to providers. Providers maintain their provider information as well as ordering policies.

Error Code Description
AuthenticatorDefInvalid

Indicates that an order authenticator for the provider is not valid and could not be created. Please refer to the API documentation and supporting material for more information on the structure of authenticator definitions.

ProviderCatalogItemOptionsFound

Indicates that provider to be deleted has catalog item options.

ProviderContactRolesNotUnique

Indicates that a contact was added or updated for a provider but the role of the contact was not unique. All of the roles of contacts for a provider must be unique.

ProviderDataRulesFound

Indicates that provider to be deleted has data rules.

ProviderDescriptionMissing

Indicates that a description was not given for a provider. A provider must have at least one description for their holdings or services.

ProviderEndpointUnreachable

Indicates that the endpoint for the provider could not be reached. Normally this indicates there is a problem communicating with the configured endpoint.

ProviderExtendedServicesFound

Indicates that provider to be deleted has extended services.

ProviderIdExists

Indicates that the given provider id already exists. Provider ids must be unique in the system for all providers.

ProviderIdInvalid

Indicates that the provider id does not meet the requirements for a valid id. Refer to the API documentation for the list of rules applied to a provider id.

ProviderNotFound

Indicates that the provider cannot be found. Normally this occurs because the provider id is incorrect. Provider (and user) ids are case sensitive.

ProviderOrdersFound

Indicates that provider to be deleted has orders.

ProviderPoliciesInvalid

Indicates that provider policies for the provider are invalid. Normally this occurs because the SSL policy is out of synch with the provider's endpoint.

ProviderPoliciesNotFound

Indicates that provider policies for the provider cannot be found. Normally this occurs because the provider has not set policies but is attempting to perform an operation that requires policies.

ProviderSchemaNameInvalid

Indicates that the schema name does not meet the requirements for a valid schema name. Refer to the API documentation for the list of rules applied to a provider schema name.

ProviderSchemaNotFound

Indicates that the provider schema could not be found. The provider schema must exist in the database prior to activating a provider. If the schema cannot be found, the provider id cannot be verified before creating the provider.

ProviderServiceOptionsFound

Indicates that provider to be deleted has service options.

SslCertificateInvalid

Indicates that the ssl certificate provided was invalid.

SslCertificateNotActivated

Indicates that the ssl certificate for a provider was not activated. Certificates must be activated by operations before they can be used.

SslCertificateNotFound

Indicates that the ssl certificate for a provider was not found. There is no ssl certificate set for the provider.

Service Management Error Codes

All error codes related to service management.

Error Code Description
BadTagGroupType

Indicates that an attempt to perform an operation on the wrong tag group type was made.

DuplicateTagGuid

Indicates a duplicate tag was found in a list of tag Guids.

InvalidServiceOptionAssignment

Indicates an error with a service option assignment (e.g. incompatibilities between the service entry and the service option definition).

ProviderGuidChanged

Indicates that an attempt was made to change the provider to which a service entry belongs. This is not permitted.

ServiceEntryNotFound

Indicates that an attempt was made to access a service entry that does not exist.

ServiceNameExists

Indicates that a service entry with the given name already exists. Service entry names must be unique across the entire system.

ServiceOptionDefinitionNameExists

Indicates that a service option definition with the given name already exists. Service option definition names must be unique across the entire system.

ServiceOptionDefinitionNotFound

Indicates that a service option definition could not be found.

TagExists

Indicates an attempt to create a duplicate tag.

TagGroupNameExists

Indicates that a service tag group with the given name already exists.

TagGroupNotFound

Indicates that an attempt was made to access a tag group that does not exist.

TagGroupNotManaged

Indicates that an attempt was made to perform an operation that required a managed tag group.

TagNotFound

Indicates an attempt to use a tag that does not exist.

User Error Codes

All error codes related to users. Users manage their user information as well as preferences and authenticators.

Error Code Description
OldPasswordInvalid

Indicates that the old user password is not valid. Normally this occurs when attempting to change a user password but the current or old password is not valid, therefore the new password cannot be applied.

PasswordInvalid

Indicates that the password is not valid. A user password must meet particular criteria to be considered valid. The criteria are designed to create a complex password for security reasons. Refer to the API documentation for the rules required for a password.

ProviderRoleAccessDenied

Indicates that the caller does not have access to the provider role required to complete the operation. This normally occurs when granting or revoking access to a provider when the caller does not have access to the provider already.

UserAuthenticatorExists

Indicates that an authenticator with the same name already exists for this user. Authenticator names must be unique for a user.

UserAuthenticatorNotFound

Indicates that the requested authenticator could not be found. Authenticators are owned by a single user and can be removed by that user.

UserDomainInvalid

Indicates that the user domain is not valid for the current operation. This normally occurs when an operation will not accept a particular domain but the client sent the domain value as a parameter to the operation.

UserIdExists

Indicates that the user id already exists and cannot be used. User ids must be unique in the system. A new user id must be chosen.

UserIdInvalid

Indicates that the user id is not valid based on the rules applied to the id. Refer to the API documentation for the specific requirements of a user id.

UserNotFound

Indicates that the requested user could not be found. Normally this occurs if the id is invalid, or if the caller does not have permission to the requested user.

UserPreferencesNotFound

Indicates that user preferences for the user could not be found. User preferences are optional and therefore may not have been set. Normally this only occurs if an attempt is made to remove user preferences that do not exist.

UserPrimaryStudyArea

Indicates that the user primary study area is not valid for the current operation. This normally occurs when an operation will not accept a particular primary study area but the client sent the domain value as a parameter to the operation.

UserRegionInvalid

Indicates that the user region is not valid for the current operation. This normally occurs when an operation will not accept a particular region but the client sent the region value as a parameter to the operation.

UserType

Indicates that the user type is not valid for the current operation. This normally occurs when an operation will not accept a particular type but the client sent the type value as a parameter to the operation.