getPlanScanFrequency — Retrieving the scan frequency for a plan

The getPlanScanFrequency method retrieves the available scan frequency options for a given plan ID.

This method applies only to product_category="SCAN" and type="plan".

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
- getPlanScanFrequency: The method name
- id: The plan ID for which to retrieve scan frequency information.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getPlanScanFrequency>
        <id>12</id>
    </getPlanScanFrequency>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getPlanScanFrequency: The method name
  - <scan_type>: (Repeatable) The scan type
    
    feature_type: [attribute] - The type of the feature. The possible values are recurring and on_demand.
    
    If the value of feature_type is on_demand, the options element doesn’t have any sub element.
    
    options: A list of available frequency options for the scan.
    
    option: (Repeatable) The scan frequency. The possible values are daily, weekly, monthly, and annual.

Example success response

<SiteLockOnlineResponse>
  <getPlanScanFrequency>
    <smart_scan>
      <options>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
      <feature_type>recurring</feature_type>
    </smart_scan>
    <vulnerability_scan>
      <options>
      </options>
      <feature_type>on_demand</feature_type>
    </vulnerability_scan>
    <db_scan>
      <feature_type>recurring</feature_type>
      <options>
        <option>hourly</option>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
    </db_scan>
    <malware_scan>
      <feature_type>recurring</feature_type>
      <options>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
    </malware_scan>
    <patchman>
      <options>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
      <feature_type>recurring</feature_type>
    </patchman>
    <spam_scan>
      <options>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
      <feature_type>recurring</feature_type>
    </spam_scan>
    <ssl_scan>
      <options>
        <option>daily</option>
        <option>weekly</option>
        <option>monthly</option>
        <option>quarterly</option>
        <option>never</option>
      </options>
      <feature_type>recurring</feature_type>
    </ssl_scan>
  </getPlanScanFrequency>
</SiteLockOnlineResponse>

Error response

If the request fails (for example, due to an invalid product ID or authentication issue), an error message will be returned.

Example error response

<SiteLockOnlineResponse>
    <getPlanScanFrequency>
        <message>Invalid product ID</message>
        <status>error</status>
    </getPlanScanFrequency>
</SiteLockOnlineResponse>