File Upload

UploadFile [finished]

Overlays:

    Activation:

    UploadFile.php ? sessionID = ... & file = ... & mimeTypeID = ...

    Description:

        Uploads a file. File name cannot contain characters other than alphanumeric and ".-_".

    Parameters:

    • sessionID: string(16)
    • file: file - file to upload
    • mimeTypeID: uint

    Results:

    <UploadFile>
        <status>OK</status>
        <fileID>1234</fileID> : uint
    </UploadFile>

    Throw Errors:



    GetFileInfo [finished]

    Overlays:

      Activation:

      GetFileInfo.php ? sessionID = ... & fileID = ...

      Description:

          Returns information about given file.

      Parameters:

      • sessionID: string(16)
      • fileID: uint

      Results:

      <GetFileInfo>
          <status>OK</status>
          <files>
              <file>
                  <fileID>456</fileID> : uint
                  <mimeTypeID>10</mimeTypeID> : uint
                  <mimeTypeName>application/x-shockwave-flash</mimeTypeName> : string(63)
                  <emiterID>6</emiterID> : nullable uint
                  <emiterLocation>gde.adocean.pl/plik.swf</emiterLocation> : string(1023)
                  <uploadStatus>Pending</uploadStatus> : enum('OK','Pending','Fresh')
                  <creationTS>1242123024</creationTS> : uint
              </file>
          </files>
      </GetFileInfo>

      Throw Errors:



      GetMimeTypesList [finished]

      Overlays:

        Activation:

        GetMimeTypesList.php ? sessionID = ...     
            [ & extensionsPattern = ... ]
                
            [ & commentsPattern = ... ]
                
            [ & sortField = ... ]
                
            [ & sortOrder = ... ]
                
            [ & limit = ... ]
                
            [ & offset = ... ]

        Description:

            Returns list of MIME types matching specified criteria.

        Parameters:

        • sessionID: string(16)
        • extensionsPattern: string(100)
        • commentsPattern: string(255)
        • sortField: enum('name', 'extensions')
        • sortOrder: enum('asc','desc')
        • limit: uint - limits result to given number of records
        • offset: uint - skips given number of records

        Results:

        <GetMimeTypesList>
            <status>OK</status>
            <mimeTypesNumber>1234</mimeTypesNumber> : uint - all records number (if there were no limit and offset)
            <mimeTypes>
                <mimeType>
                    <mimeTypeID>1234</mimeTypeID> : uint
                    <name>image/gif</name> : string(63)
                    <extensions>gif</extensions> : string(63)
                    <comments>GIF Image; Defined in RFC 2045 and RFC 2046</comments> : string(255)
                </mimeType>
            </mimeTypes>
        </GetMimeTypesList>

        Throw Errors: