Spec - Wiki

Table Of Contents

• Get Wiki Topics
• Get Wiki
• Add Wiki
• Edit Wiki
• Delete Wiki

Get Wiki Topics

This function allows the caller to retrieve a group’s wiki topics list from the database.

Search parameters should be specified inside the tag.

Input

• account_id (required for shared access)
• group_id
• search

Output

Success or failure. A list of wiki topics.

Example Request

<GetWikiTopicsRequest group_id="4"></GetWikiTopicsRequest>

Example Request

<GetWikiTopicsRequest group_id="4" search="Test"></GetWikiTopicsRequest>

Example Request

<GetWikiTopicsRequest account_id="38193" group_id="34"></GetWikiTopicsRequest>

Successful Response

<GetWikiTopicsResponse>
    <Result>Success</Result>
    <WikiTopics>
        <WikiTopic>
            <WikiID>4</WikiID>
            <AllGroupMembersCanWrite>N</AllGroupMembersCanWrite>
            <Title>Test</Title>
            <ParentID>0</ParentID>
            <Public>N</Public>
            <Excerpt>Enter wiki content here</Excerpt>
        </WikiTopic>
        <WikiTopic>
            <WikiID>5</WikiID>
            <AllGroupMembersCanWrite>N</AllGroupMembersCanWrite>
            <Title>Test</Title>
            <ParentID>0</ParentID>
            <Public>N</Public>
            <Excerpt>Enter wiki content here</Excerpt>
            <WikiSubtopics>
                <WikiSubtopic>
                    <WikiID>11</WikiID>
                    <AllGroupMembersCanWrite>N</AllGroupMembersCanWrite>
                    <Title>mobile</Title>
                    <ParentID>5</ParentID>
                    <Public>Y</Public>
                    <Excerpt>test</Excerpt>
                </WikiSubtopic>
            </WikiSubtopics>
        </WikiTopic>
        <WikiTopic>
            <WikiID>6</WikiID>
            <AllGroupMembersCanWrite>N</AllGroupMembersCanWrite>
            <Title>Test</Title>
            <ParentID>0</ParentID>
            <Public>N</Public>
            <Excerpt>Enter wiki content here</Excerpt>
        </WikiTopic>
    </WikiTopics>
</GetWikiTopicsResponse>

Get Wiki

This function allows the caller to retrieve wiki from the database.

Search parameters should be specified inside the tag.

Input

• account_id (required for shared access)
• wiki_id

Output

Success or failure. Wiki data.

Example Request

<GetWikiRequest wiki_id="5"></GetWikiRequest>

Successful Response

<GetWikiResponse>
    <Result>Success</Result>
    <Wiki>
        <WikiID>5</WikiID>
        <AllGroupMembersCanWrite>N</AllGroupMembersCanWrite>
        <Title>Test</Title>
        <ParentID>0</ParentID>
        <Public>N</Public>
        <Excerpt>Enter wiki content here</Excerpt>
        <Content>&lt;p&gt;Enter wiki content here&lt;/p&gt;</Content>
    </Wiki>
</GetWikiResponse>

Add Wiki

This function allows the caller to add wiki.

Search parameters should be specified inside the tag.

The caller must have wiki edit permissions to an account in order to this action.

Input

• account_id
• group_id
• Title
• Content
• ParentID
• AllGroupMembersCanWrite
• PublicTopic

Output

Success or failure for each wiki. Wiki ID.

Example Request

<AddWikiRequest group_id="4">
    <Title>Sample</Title>
    <Content>&lt;p&gt;Sample content.&lt;&#x2F;p&gt;</Content>
    <ParentID>0</ParentID>
    <AllGroupMembersCanWrite>Y</AllGroupMembersCanWrite>
    <PublicTopic>Y</PublicTopic>
</AddWikiRequest>

Successful Response

<AddWikiResponse>
    <Result>Success</Result>
    <WikiID>13</WikiID>
</AddWikiResponse>

Edit Wiki

This function allows the caller to modify one or more opportunity products already in the database.

Search parameters should be specified inside the tag, while parameters to change to would be specified individually.

The caller must have wiki edit permissions to an account in order to this action.

Input

• account_id
• group_id
• wiki_id
• Title
• Content
• ParentID
• AllGroupMembersCanWrite
• PublicTopic

Output

Success or failure for each products. List of products.

Example Request

<EditWikiRequest group_id="4" wiki_id="1">
    <Title>Sample</Title>
    <Content>&lt;p&gt;Sample content.&lt;&#x2F;p&gt;</Content>
    <ParentID>0</ParentID>
    <AllGroupMembersCanWrite>Y</AllGroupMembersCanWrite>
    <PublicTopic>Y</PublicTopic>
</EditWikiRequest>

Example Response

<EditWikiResponse>
    <Result>Success</Result>
    <WikiID>13</WikiID>
</EditWikiResponse>

Delete Wiki

This function allows the caller to delete one or more opportunity products from the database.

Search parameters should be specified inside the tag.

The caller must have wiki edit permissions to an account in order to this action.

Input

• account_id
• group_id
• wiki_id

Output

Success or failure for each products. List of products.

Example Request

<DeleteWikiRequest group_id="4" wiki_id="1"/>

Example Response

<DeleteWikiResponse>
    <Result>Success</Result>
    <WikiID>13</WikiID>
</DeleteWikiResponse>