Spec - Media Library

Table Of Contents

• Upload Media
• Get Media Library Request

Upload Media

This function allows the caller to upload media into the account.

Input

• account_id (required for shared access users)
• group_id (required)
• MediaFolder (required)
• Filename (required)
• Content (required)
• Type (Files, Images, Videos, Articles, Documents)
• Description
• ContactsCanView (Y/N)
• PublicCanView (Y/N)

Output

Success or error. MediaID.

Example Request

<UploadMediaRequest group_id="1">
    <Type>Images</Type>
    <MediaFolder>Social Uploads</MediaFolder>
    <Filename>27384.jpg</Filename>
    <Content>(base64 encoded file contents)</Content>
    <Description>Logo</Description>
    <ContactsCanView>Y</ContactsCanView>
    <PublicCanView>Y</PublicCanView>
</UploadMediaRequest>

Example Request (shared access)

<UploadMediaRequest account_id="38193" group_id="1">
    <Type>Images</Type>
    <MediaFolder>Social Uploads</MediaFolder>
    <Filename>27384.jpg</Filename>
    <Content>(base64 encoded file contents)</Content>
    <Description>Logo</Description>
    <ContactsCanView>Y</ContactsCanView>
    <PublicCanView>Y</PublicCanView>
</UploadMediaRequest>

Successful Response

<UploadMediaResponse>
    <Result>Success</Result>
    <MediaID>30</MediaID>
</UploadMediaResponse>

Get Media Library Request

This function allows the caller to get info about a group’s media library.

Input

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

Output

Returns a list of media file metadata for the group.

• MediaID
• Filename
• Description
• Folder
• Type
• Size (KB)

Example Request

<GetMediaLibraryRequest group_id="1"></GetMediaLibraryRequest>

Example Request (shared access)

<GetMediaLibraryRequest account_id="38193" group_id="1"></GetMediaLibraryRequest>

Successful Response

<GetMediaLibraryResponse>
    <Result>Success</Result>
    <Media>
        <MediaID>25</MediaID>
        <Filename>Media25.png</Filename>
        <Description>some file</Description>
        <Folder>My Files</Folder>
        <Type>Files</Type>
        <Size>1</Size>
    </Media>
    <Media>
        <MediaID>1</MediaID>
        <Filname>Media1.png</Filname>
        <Description>my picture</Description>
        <Folder>Social Uploads</Folder>
        <Type>Images</Type>
        <Size>12</Size>
    </Media>
</GetMediaLibraryResponse>