ProcessSmartPadArchive

The ProcessSmartPadArchive method archives a SmartPad entry or restores an archived SmartPad entry.

The ProcessSmartPadArchive method is invoked using the MethodOperation.

Parameters

Name Type Description
SmartPadID String Required. This is the object ID of the SmartPad entry you want to archive or restore.
NoteStatus String Required. Enter 0 (to restore an archived SmartPad entry) or 1 (to archive an entry).
Category String Required when NoteStatus is 1. This is the SmartPad entry's classification for archiving purposes. Valid values: 1 (System-Generated Note), 2 (Old Note), 3 (Other), 4 (Incorrect Note).
Reason String Required when Category is 3. This is a description of why the SmartPad? entry is being archived.

Examples

The following request archives a SmartPad entry (identified by its object ID), assigns it to the Other archive category and provides a reason for the action. The response returns the object ID of the archived entry.

Request XML
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <method>
        <ProcessSmartPadArchive>
            <SmartPadID>SmartPad.1.87</SmartPadID>
            <NoteStatus>1</NoteStatus>
            <Category>3</Category>
            <Reason>No longer relevant</Reason>
        </ProcessSmartPadArchive>
    </method>
</request>

Response XML
<response version="1.0">
    <header>
        <sessionClosed/>
    </header>
    <method>
        <ProcessSmartPadArchive>
            <SmartPadArchive id="SmartPadArchive.1.87">SmartPad Archived</SmartPadArchive>
        </ProcessSmartPadArchive>
    </method>
    <_status>OK</_status>
    <_systime>2015-10-02T16:31:16</_systime>
    <!--Cost 1017 mill seconds.-->
</response>

The following example restores the SmartPad entry archived in the previous example.

Request XML
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <method>
        <ProcessSmartPadArchive>
            <SmartPadID>SmartPadArchive.1.87</SmartPadID>
            <NoteStatus>0</NoteStatus>
        </ProcessSmartPadArchive>
    </method>
</request>

Response XML
<response version="1.0">
    <header>
        <sessionClosed/>
    </header>
    <method>
        <ProcessSmartPadArchive>
            <SmartPad id="SmartPad.1.87">SmartPad Restored</SmartPad>
        </ProcessSmartPadArchive>
    </method>
    <_status>OK</_status>
    <_systime>2015-10-02T16:42:18</_systime>
    <!--Cost 222 mill seconds.-->
</response>

-- DinosLambropoulos - 06 Oct 2015
Topic revision: 06 Feb 2017, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback