archive

Archives ads.

  1. Request
  2. Response

Request

Request structure in JSON format:


  "params" : { /* required */
    "SelectionCriteria" : { /* required */
      "Ids" : [ (long) ] /* required */
    }
  }
Parameter Type Description Required
Params structure (for JSON) / ArchiveRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting portfolio strategies to archive. Yes
IdsCriteria structure
Ids array of long IDs of portfolio strategies to archive (no more than 10,000). Yes
Parameter Type Description Required
Params structure (for JSON) / ArchiveRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting portfolio strategies to archive. Yes
IdsCriteria structure
Ids array of long IDs of portfolio strategies to archive (no more than 10,000). Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "ArchiveResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ] 
    }, ... ] /* required */
  }
}
Parameter Type Description
Result structure (for JSON) / ArchiveResponse structure (for SOAP)
ArchiveResults array of ActionResult Results of archiving portfolio strategies.
ActionResult structure
Id long Portfolio strategy ID. Returned if there are no errors, see Operations on object arrays.
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.

Parameter Type Description
Result structure (for JSON) / ArchiveResponse structure (for SOAP)
ArchiveResults array of ActionResult Results of archiving portfolio strategies.
ActionResult structure
Id long Portfolio strategy ID. Returned if there are no errors, see Operations on object arrays.
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.