ResponseStatus

This element appears in most of the responses that are issued when the Test Management API operations are invoked.

Derived by

Type ResponseStatusType

Enumeration

  • SUCCESS - The monitor order was successfully processed.
  • FAILURE - The monitor order could not be processed.

Referenced by

Example

Here is an example from a GetTestsResponse:

<GetTestsResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <Monitors/>
</GetTestsResponse>

Here is an example from a GetSitesResponse:

<GetSitesResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <MonitorSites>
      <MonitorSite siteId="777" siteName="TPN7 - MA: Boston"
         city="Lexington" state="MA" countryCode="US" ipV6Enabled="false"/>
      <MonitorSite siteId="850" siteName="TPN1 - Boston MA - SAVVIS"
         city="WALTHAM" state="MA" countryCode="US" ipV6Enabled="true"/>
   </MonitorSites>
</GetSitesResponse>

Here is an example from a TestStatusUpdateResponse:

<TestStatusUpdateResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
</TestStatusUpdateResponse>

Here is an example from an UpdateTestParametersResponse:

<UpdateTestParametersResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
</UpdateTestParametersResponse>

Here is an example from an UpdateTestsResponse:

<UpdateTestsResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <MonitorOrderResponses>
      <MonitorOrderResponse name="js_2012-08-16T13:11:50.460_FF 2"
         folder="ws_provision" monitorId="306528" monitorStatus="Active"
         orderStatus="SUCCESS">
         <Message>Successfully provisioned monitor: AccountName = DEV - Eric Smith,
            MonitorName = eg_2012-08-16T13:11:50.460_FF 2, MonitorId =306528</Message>
      </MonitorOrderResponse>
   </MonitorOrderResponses>
</UpdateTestsResponse>

Here is an example from a GetTestsSummaryResponse:

<GetTestsSummaryResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <MonitorSummaries/>
</GetTestsSummaryResponse>

Here is an example from a GetParameterizedTestsResponse:

<GetParameterizedTestsResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <ParameterizedMonitor monitorId="328430" createDate="2012-11-13T21:27:29.513"
      modifyDate="2012-11-21T18:57:53.393" monitorStatus="Active">
      <SubstitutionParameters>
         <SubstitutionParameter id="0" name="UserName"
            value="Updated User 11/05/2012 2:56:05 PM"/>
         <SubstitutionParameter id="1" name="Password" value="EricS"/>
      </SubstitutionParameters>
      <MonitorSites>
         <MonitorSite siteId="886"/>
      </MonitorSites>
   </ParameterizedMonitor>
</GetParameterizedTestsResponse>

Based on the number of examples provided, a ResponseStatus tells you either that the operation completed successfully or that it failed, and the failure was due to a business rule violation on the part of the API client or because of some problem with the Dynatrace Synthetic Monitoring system.