SOAP Response Status Messages
The following lists identify the status messages contained in SOAP responses
for web service operations:
Common status messages
The following status messages can be returned by all web service operations
- OK: The
web service operation was performed successfully. For example, if this
message is received in an AddDevice SOAP Response, this status would indicate
that the Device was successfully created.
- AUTHENTICATION_ERROR:
the credentials supplied in the SOAP request are invalid
- INVALID_CLIENT_TIMESTAMP:
the supplied clientTimestamp is invalid.
- UNKNOWN_APPLICATION_ERROR:
an exception is thrown.
Operation-specific status messages
The following status messages are specific to the operation being called:
- BOTH_SEARCH_PARAMETERS_SPECIFIED:
only one search parameter can be specified.
- CIRCULAR_REFERENCE:
specified replacement would create a loop (e.g., UserA replaces UserB
who replaced UserA).
- COMPANY_DOES_NOT_EXIST: specified Company does not exist within xMatters.
- CUSTOM_ATTRIBUTE_INVALID:
a specified Custom Attribute does not match a Custom Attribute in the
xMatters system.
- CUSTOM_ATTRIBUTE_VALUE_INVALID:
a specified Custom Attribute value does not match a configured attribute
value.
- CUSTOM_FIELD_INVALID:
a specified Custom Field does not match a Custom Field in the xMatters
system.
- CUSTOM_FIELD_VALUE_INVALID:
a specified Custom Field value is invalid for its configured type and
parameters.
- DEVICE_DOES_NOT_EXIST:
specified identifier does not correspond to a Device in the xMatters
Database.
- DEVICE_INVALID COUNTRY: the specified country code is not a valid two-letter code.
- DEVICE_NAME_IN_USE: owner of the specified Device already has
a Device configured with the specified Device name.
- DEVICE_PIN_AND_NUMBER_MUTUALLY_EXCLUSIVE: as of 4.1 patch 006 and 4.0 patch 014, updating a numeric pager via web services will no longer accept both a pin and a phone number; you can submit either a pin or an area code and phone number, but not both.
- DUPLICATE_ATTRIBUTE_EXISTS:one or more of the specified attributes already exists within the Company.
- DUPLICATE_CATEGORY: the specified Category name already exists within the Company.
- DUPLICATE_TIMEFRAME: specified Timeframe already exists.
- DURATION_HOURS_NOT_VALID:
duration hours are not an integer greater than or equal to 0.
- DURATION_MINUTES_NOT_VALID:
duration minutes are not an integer greater than or equal to 0.
- EMPTY_RESULT_SET:
no results returned.
- EVENT_ALREADY_DELETED:
specified event has already been terminated.
- EVENT_DOMAIN_DOES_NOT_EXIST: the specified Event Domain has not been configured on the xMatters
system.
- EVENT_NOT_ACTIVE:
the targeted event is not currently ACTIVE.
- EVENT_NOT_FOUND:
the passed eventIdentifier does not correspond to an event in the system.
- EVENT_NOT_SUSPENDED:
the targeted event is not currently SUSPENDED.
- FAILED_ATTRIBUTE_IN_USE: the specified category has an attribute in use within the Company.
- FIRST_NAME_INVALID:
the specified first name exceeds 100 characters.
- GROUP_DOES_NOT_HAVE_SHIFTS_IN_SPECIFIED_RANGE:
Group contains no shifts in the specified range.
- GROUP_NAME_IN_USE:
the specified Group name is in use by another Group.
- GROUP_NOT_FOUND: specified Group is invalid.
- HOLIDAY_SHIFT_NO_SITE_SET:
a Group specified has no Site associated with it and cannot be assigned
Holiday Coverages.
- INVALID_COVERAGE_PARAMETER: the SoapCoverageParameter is not defined correctly; it must specify one of the available shift types and the other two shift types (if present) must be set to "nil".
- INVALID_DATE_RANGE:
the endDate is earlier than the startDate.
- INVALID_DEVICE:
one of the specified Device identifiers does not identify a Device associated
with the specified owner.
- INVALID_DEVICE_IDENTIFIER:
specified Device does not exist in the xMatters system.
- INVALID_DEVICE_TYPE:
supplied Device type is invalid.
- INVALID_DURATION:
duration is not greater than 0.
- INVALID_END_DATE:
the specified end date is invalid.
- INVALID_END_TIMESTAMP:
specified end timestamp is invalid.
- INVALID_ESCALATION:
supplied escalation is invalid.
- INVALID_MEMBER_TYPE:
the type of a specified Team member is not one of PERSON, DEVICE, GROUP,
TEAM, or DYNAMIC_TEAM.
- INVALID_OPERATOR_TYPE:
supplied operator type is invalid.
- INVALID_ORDER:
specified ordinals do not specify a valid Device order
- INVALID_OWNER:
specified owner is unknown to the xMatters system.
- INVALID_PERIOD:
period specified by the start and end timestamps is less than or equal
to 0 seconds.
- INVALID_PERSON:
specified User is unknown to the xMatters system.
- INVALID_PREDICATE_NAME:
supplied predicate name is invalid.
- INVALID_PRIORITY_THRESHOLD:
the specified priorityThreshold is not one of HIGH, MEDIUM, or LOW.
- INVALID_RECIPIENT_NAME:
supplied recipient name is invalid.
- INVALID_RECIPIENT_TARGETNAME:
specified recipent target name is invalid.
- INVALID_RECIPIENT_TYPE:
supplied recipient type is invalid.
- INVALID_REPLACED_USER:
the User specified to be replaced does not exist.
- INVALID_REPLACEMENT_USER:
the specified replacement User does not exist.
- INVALID_ROTATION_INTERVAL:
the rotation interval is not a positive integer.
- INVALID_ROTATION_START:
the specified rotationStart is not a well formatted date.
- INVALID_ROTATION_UNIT:
the rotation unit is not DAYS, WEEKS, or MONTHS.
- INVALID_SITE: the specified site is unknown to the xMatters system.
- INVALID_START_DATE: specified start date is invalid
- INVALID_START_TIME:
supplied start time is invalid.
- INVALID_START_TIMESTAMP:
specified start timestamp is invalid.
- INVALID_STATE_LIST: if a state in the specified state list is not a valid event state.
- INVALID_SUBSCRIPTION_DOMAIN: supplied subscription domain. is invalid.
- INVALID_SUPERVISOR_NAME:
supplied supervisor name is invalid.
- INVALID_SUPERVISOR_TARGETNAME: specified supervisor target name is invalid.
- INVALID_TEMPORARY_REPLACEMENT_ID: specified Temporary Replacement identifier does not match a Temporary
Replacement in the database.
- INVALID_TIMEFRAME_IDENTIFIER: specified Device Timeframe does not exist.
- INVALID_TIMEZONE:
the specified time zone is invalid or unknown to the xMatters system.
- INVALID_TYPE: the specified Team type is not BASIC, EVENT_ROUND_ROBIN, or ROTATION.
- INVALID_VALIDATION_CODE: specified code is not valid.
- INVALID_WEB_SERVICES_VERSION: incorrect end point targeted by web service call; for more information, see Accessing web services.
- INVALID_WEEKDAYS: all days of the week are excluded from the Schedule.
- LANGUAGE_INVALID: the specified language does not exist in the xMatters system.
- LAST_NAME_INVALID: the specified last name exceeds 100 characters.
- LDAP_DOMAIN_MISSING:
the web login type is LDAP and no LDAP domain is specified.
- MISSING_DEVICE:
the specified owner's Devices are not included in the list.
- MISSING_ROTATION_INTERVAL: specified Team type is ROTATION and no rotationInterval is specified.
- MISSING_ROTATION_START: specified Team type is ROTATION and no rotationStart is specified
- MISSING_ROTATION_UNIT: specified Team type is ROTATION and no rotationUnit is specified.
- MULTIPLE_DEVICES_SPECIFIED: multiple Devices are specified in the request.
- NO_DEVICE_TIMEFRAMES_DELETED:
search criteria does not match any Device.
- NO_DEVICES_DELETED:
search criteria does not match any Devices.
- NO_PHONE_LOGIN:
specified User does not have a phone login.
- NO_SEARCH_PARAMETERS_SPECIFIED:
a search parameter is required.
- NO_SUBSCRIPTIONS_DELETED:
no Subscriptions were deleted.
- NO_SUCH_DEVICE:
specified Device does not exist.
- NO_SUCH_DEVICE_TIMEFRAME:
specified Device Timeframe does not exist.
- NO_TEMPORARY_REPLACEMENTS_DELETED:
search criteria does not match any Temporary Replacements.
- OWNER_REQUIRED: a valid owner must be specified for the web service to function
- PHONE_LOGIN_EXISTS:
specified login already exists.
- PHONE_LOGIN_IN_USE:
the specified phone login is used by another User.
- PHONE_LOGIN_INVALID:
the specified phone login is not numeric, not greater than 0 or exceeds
30 characters.
- PHONE_PASSWORD_INVALID:
the specified phone password is not numeric, not greater than 0 or exceeds
30 characters.
- PHONE_PASSWORD_VIOLATES_POLICY:
the specified phone password does not conform to the configured policy.
- REGISTRATION_ACL_FAILED:
integration agent was not allowed to register.
- REPLACED_USER_NOT_MEMBER_OF_GROUP:
replaced User not a member of one of the specified Groups.
- ROLE_INVALID:
a specified Role is not configured in the xMatters system.
- ROLE_REQUIRED:
no Roles are specified for the specified User.
- SEARCH_PARAMETER_REQUIRED:
no search parameters were specified.
- SITE_INVALID:
the specified Site does not exist in the xMatters system.
- START_DATE_GREATER_THAN_END_DATE:
startDate is before the endDate. This error message can also be returned from some web services (such as FindWhoIsOnDuty) when the specified start date is not greater than the end date. This occurs when both the startDate and endDate are earlier than the current time and date; the web service automatically adjusts the startDate to the current date, but does not adjust the endDate, resulting in the START_DATE_GREATER_THAN_END_DATE error.
- SUBSCRIPTON_DOMAIN_NAME_REQUIRED:
Subscription Domain not specified.
- SUBSCRIPTION_DOMAIN_NOT_FOUND:
the specified Subscription Domain does not exist in the xMatters system.
- SUBSCRIPTION_NAME_IN_USE:
supplied Subscription name is in use.
- SUBSCRIPTION_PREDICATE_REQUIRED:
a Subscription predicate is required.
- SUBSCRIPTION_RECIPIENT_REQUIRED:
a Subscription recipient is required.
- UNKNOWN_SUBSCRIPTION:
specified Subscription does not exist.
- SUBSCRIPTION_SUPERVISOR_REQUIRED:
a Subscription supervisor is required.
- SUPERVISOR_INVALID:
a specified supervisor is not configured in the xMatters system.
- SUPERVISOR_REQUIRED:
no supervisors are specified.
- TARGET_NAME_IN_USE:
the specified target name is already used in the system.
- TARGET_NAME_INVALID:
the specified target name contains the '|' character or exceeds 100 characters.
- TEAM_NAME_IN_USE:
the specified Team name is already in use by another Team in the specified
Group.
- TEAM_NOT_REUSABLE:
a specified Team is already associated with a Schedule and is not marked
as reusable.
- TIMEZONE_INVALID:
the specified time zone does not exist in the xMatters system.
- TYPE_MISMATCH:
Device identified by the specified identifier has a different type than
the Device specified.
- UNDEFINED_ATTRIBUTE:
specified Attribute name does not match an Attribute configured in the
xMatters system.
- UNDEFINED_CUSTOM_FIELD:
specified Custom Field name does not match an Custom Field configured
in the xMatters system.
- UNKNOWN_CATEGORY_NAME: The specified Custom Attribute category does not exist within the Company.
- UNKNOWN_COMPANY_NAME: specified Company name does not exist within xMatters.
- UNKNOWN_COVERAGE:
the specified Coverage is not associated with the specified Group.
- UNKNOWN_DEVICE_NAME:
Specified Device name does not correspond to a Device name configured
for the specified Device type.
- UNKNOWN_DOMAIN:
one of the specified domain names has not been configured on the xMatters
system.
- UNKNOWN_EVENT:
specified event identifier does not match an event in the database.
- UNKNOWN_GROUP:
the specified Group name does not correspond to a Group in the xMatters
system.
- UNKNOWN_INCIDENT:
the passed incidentIdentifier does not correspond to an incident in the
system.
- UNKNOWN_MEMBER:
the specified targetName of a Team member is unknown to the xMatters
system.
- UNKNOWN_ROLE:
one or more of the specified observer Roles does not specify an xMatters
Role.
- UNKNOWN_SERVICE:
one of the specified services has not been configured on the xMatters
system.
- UNKNOWN_SUBSCRIPTION_DOMAIN:
an invalid Subscription Domain was specified.
- UNKNOWN_SUPERVISOR:
one or more of the specified supervisors does not specify an xMatters
User.
- UNKNOWN_TEAM:
the specified Team is not associated with the specified Group OR the specified Team does not exist within the Company.
- UNKNOWN_USER:
the specified target name does not match a User in the xMatters system.
- USER_IS_THE_LAST_SUPERVISOR_FOR_SOME_GROUP:
the specified User is the only supervisor for one or more Groups.
- WEB_LOGIN_IN_USE:
the specified web login is used by another User.
- WEB_LOGIN_INVALID:
the specified web login exceeds 100 characters.
- WEB_LOGIN_TYPE_INVALID:
the specified web login type is not WEB or LDAP.
- WEB_PASSWORD_INVALID:
the specified web password exceeds 30 characters.
- WEB_PASSWORD_VIOLATES_POLICY:
the specified web password does not conform to the configured policy.
Device validation errors:
- DEVICE_INVALID_NAME
- DEVICE_INVALID_AREA_CODE
- DEVICE_INVALID_NUMBER
- DEVICE_INVALID_EXTENSION
- DEVICE_INVALID_PIN_OR_EMAIL
- DEVICE_INVALID_PIN
- DEVICE_INVALID_ADDRESS