Announcement

Collapse
No announcement yet.

Legacy Mobile API (vB 3 / vB4)

Collapse
  • Filter
  • Time
  • Show
Clear All
new posts

  • Method List

    Method List

    A list of all methods found within the Mobile API organized by class.

    REST Server Specific Methods
    • api_init [v3|v4]
      Register a new client or returns API info and Access Token.
    • api_usersearch [v3|v4]
      Returns usernames for username suggestion.

    User Related Methods
    • login_login [v3|v4]
      Login a user and return a new session hash.
    • login_logout [v3|v4]
      Logout a user and return a new session hash.
    • login_lostpw [v3|v4]
      Return human verify for lostpw.
    • login_emailpassword [v3|v4]
      Email the reset password link to the user.
    • login_resetpassword [v3|v4]
      Reset the password by the activationid.
    • register [v3|v4]
      Return registration form related data to client.
    • register_checkdate [v3|v4]
      Check COPPA date before return registration form related data to client.
    • register_addmember [v3|v4]
      Register a new user.


    Forum Related Methods
    • forum [v3|v4]
      Returns forum homepage related information
    • api_forumlist [v3|v4]
      Returns information of all forums (with permission check).

    Thread/Post Related Methods
    • forumdisplay [v3|v4] Return a list of threads and other related information in a forum
    • forumdisplay_markread [v3|v4] Mark the threads in a forum or all forums as read
    • newthread_newthread [v3|v4] Return new thread form related data
    • newthread_postthread [v3|v4] Post new thread
    • newreply_newreply [v3|v4] Return new reply form related data
    • newreply_postreply [v3|v4] Post new reply for a thread
    • poll_newpoll [v3|v4] Return new poll form related data
    • poll_postpoll [v3|v4] Post a new poll
    • poll_polledit [v3|v4] Return edit poll form related data
    • poll_updatepoll [v3|v4] Update a poll
    • poll_showresults [v3|v4]
    ...
    See more | Go to post

  • API Overview

    API Overview

    The Mobile API allows you to access existing vBulletin structures through a REST Server via GET and POST requests to your server.

    REST Interface
    The API uses a REST-like interface. This means that our API method calls are made over the internet by sending HTTP GET or POST requests to the vBulletin API REST server (http://www.yourforumurl.com/api.php) . Nearly any computer language can be used to communicate over HTTP with the REST server.

    Availability
    Currently the Mobile API is available in the vBulletin 4.1 download packages for both the Publishing Suite and Forum Classic software.

    File Locations
    You will find all the Mobile API files within your standard includes directory under api.

    Support
    As with all customization and coding products, support for the API will be limited at this time. Please visit vBulletin.org for all your programming support needs. We cannot provide support for third-party applications using the Mobile API.

    Method Names and Legacy Actions Mapping
    Each API method can be mapped to an action of a vB URL.

    Method Name: _() is mapped...
    See more | Go to post

  • Handling Session Timeouts

    Handling Session Timeouts

    If a client session is idle for a set period of time the session will timeout or expire. After this happens, it will no longer be valid. This value is set at "Settings -> Options -> Cookies and HTTP Header Options"->"Session Timeout", The default value is 900 seconds or 15 minutes. If session has gone through a timeout, and the client requests another API method with the signature created by the old session hash and security token, the method will return an errormessage with 'invalid_sessionhash' item. Example Code: ...
    See more | Go to post

  • Bloginfo Array

    Bloginfo Array

    The array contains the information of a blog entry information. It contains:
    • blog_title - [String] Blog title.
    • username - [String] Blog user name.
    • rating - [String] Blog entry rating.
    • ratingnum - [Integer] Number of blog entry ratings.
    • ratingavg - [Integer] Blog entry rating in average.
    • trackback_visible - [Boolean] Whether the trackback is visible.
    • views - [Integer] Number of views of the blog entry.
    • userid - [String] Blog user ID.
    See more | Go to post

  • Blog Array

    Blog Array

    This array contains the information of a blog entry. It has the following items:
    • blogid - [Integer] Blog entry ID.
    • profilepicurl - [String] Blog user's profile picture URL.
    • postedby_username - [String] Blog entry poster's username.
    • avatarurl - [String] Blog user's avatar URL.
    • title - [String] Blog entry title.
    • ratingnum - [Integer] Number of blog entry ratings.
    • date - [String] Blog entry post date.
    • time - [String] Blog entry post time.
    • blogtitle - [String] Blog title.
    • message - [String] Blog entry content.
    • edit_date - [String] Blog entry last
    ...
    See more | Go to post

  • Threadbits Array

    Threadbits Array

    Threadbits Array contains an array of threadbits in a forum. threadbit array contains the following items:
    • thread - [Array] The thread information. It contains:
      • threadid - [Integer] The ID of the thread.
      • threadtitle - [String] Thread title.
      • postusername - [String] Username of thread starter.
      • postuserid - [Integer] User ID of thread starter.
      • status - [String] Thread status. It's an array contains the statuses of the thread. Its item is in format statusname=>value. If a statusname doesn't exist in status array or its value is false, it means that the thread doesn't have such status. Otherwise it means the thread has the status. Possible statusname:
        • deleted - Thread is soft deleted.
        • moderated - Thread is under moderation.
        • dot - Thread contains posts which posted by logged-in user.
        • hot - Thread is a hot thread.
        • lock - Thread is closed.
        • new - Thread is a new thread (not viewed by the visitor before).
      • realthreadid - [Integer] If the thread is moved, this is the real thread id (threadid or redirectthreadid is the id of the redirect thread).
      • rating - [Integer] Thread rating.
      • sticky - [Boolean] Whether the thread is sticky.
      • preview - [String] Thread content preview.
      • redirectthreadid - [Inte
    ...
    See more | Go to post

  • Pagenav Array

    Pagenav Array

    Pagenav Array contains the information to construct a page navigator. It contains the following items:
    • lastnumbers - [Array] The numbers for "Last Page" link to display "Results first to last of total".
      • first - [Integer]
      • last - [Integer]

    • nextnumbers - [Array] The numbers for "Next Page" link to display "Results first to last of total".
      • first - [Integer]
      • last - [Integer]

    • nextpage - [Integer] The page number of next page.
    • pagenumber - [Integer] The page number of current page.
    • total - [Integer] The number of total records.
    • totalpages - [Integer] The number of total pages.
    • show_prior_elipsis - [Boolean] Whether to show the prior ellipsis.
    • show_after_elipsis - [Boolean] Whether to show the after ellipsis.
    • pagenav - [Array] A list of page numbers for page navigator. The sub-array contains:
      • curpage - [Integer] The number of page.
      • numbers - [Integer] The numbers for the page number link to display "Results first to last of total". Only valid if current page = curpage.
        • first - [Integer]
        • last - [Integer]
    ...
    See more | Go to post

  • Attachment Option Array

    Attachment Option Array

    Attachment Option Array contains the following items:
    • attachments - [Array] Attachments which have already been uploaded to the thread/post. It's a list of attach array that contains the following items:
      • imgpath - [String] The icon path for the attachment.
      • filesize - [String] Human friendly file size of the attachment.
      • attachmentid - [Integer] Attachment ID.
      • filename - [String] The file name (contains the extension) of the attachment.
      • extension - [String] The extension of the attachment.
    • posthash - [String] Post hash. It's the md5 value of poststarttime + userid + user_salt
    • contentid - [Integer] Content ID. For new thread/post, it's 0.
    • poststarttime - [Integer] Unix Timestamp of the post
    ...
    See more | Go to post

  • Albumbits Array

    Albumbits Array

    Albumbits Array contains a list of albums. The sub-array contains the following items:
    • album - [Array] Album information. It contains:
      • albumid - [Integer] Album ID.
      • attachmentid - [Integer] The attachment ID of album cover picture.
      • thumbnail_dateline - [Integer] Unix timestamps of the cover picture thumbnail.
      • title_html - [String] Album title.
      • picturedate - [String] Album last update date.
      • picturetime - [String] Album last update time.
      • picturecount - [Integer] Picture count in the album.
      • hasthumbnail - [Boolean] Whether the album has a cover. [v4]
      • description_html - [String] Album description.
      • lastpicturedate - [Integer] Unix timestamps of album last update time.

    • show - [Array]
      • personalalbum - [Boolean] Whether the album is a personal album. A personal album is a private
    ...
    See more | Go to post

  • User Registration Process

    User Registration Process

    Note: To Be Expanded
    1. Client needs to call method register to prepare registration.
    2. Check returned vboptions.usecoppa.
      • If it equals to 1, then the client should show an UI to prompt user to input birthday and then call register_checkdate. If there's no error returned by register_checkdate, it will return the same register form data as register. Then do the same thing as vboptions.usecoppa = 0.
      • If it equals to 0, register will return the register form data including human verify, custom required
    ...
    See more | Go to post
There are no articles in this category.
  • Filter
  • Time
  • Show
Clear All
new posts
Please log in to your account to view your subscribed posts.

Article Tags

Collapse

advanced (5) album bits (1) android (2) api (29) array (17) beginner (17) blog (4) calendar (2) cms (2) create (1) Custom (1) forum (3) forums (4) Intermediate (5) iphone (3) mapi (30) methods (10) mobile (34) pagenav (1) poll (1) post (1) style (2) threads (4) vb5howto (5) vBulletin (5)

Latest Articles

Collapse

  • Commonly Returned Arrays
    Wayne Luke
    This document lists commonly return arrays that exist in the result of many API methods.
    ...
    Mon 29th Nov '10, 5:53pm
  • Albumbits Array
    Wayne Luke
    Albumbits Array contains a list of albums. The sub-array contains the following items:
    • album - [Array] Album information. It contains:
      • albumid - [Integer] Album ID.
      • attachmentid - [Integer] The attachment ID of album cover picture.
      • thumbnail_dateline - [Integer] Unix timestamps of the cover picture thumbnail.
      • title_html - [String] Album title.
      • picturedate - [String] Album last update date.
      • picturetime - [String] Album last update time.
      • picturecount - [Integer] Picture count in the album.
      • hasthumbnail - [Boolean] Whether the album has a cover. [v4]
      • description_html - [String] Album description.
      • lastpicturedate - [Integer] Unix timestamps of album last update time.

    • show - [Array]
      • personalalbum - [Boolean] Whether the album is a personal album. A personal album is a private
    ...
    Mon 29th Nov '10, 5:51pm
  • Blog_Responsebits Array
    Wayne Luke
    The array contains a list of blog comments. The sub-array contains:
    • response - [Array]
      • blogtextid - [Integer] Comment ID.
      • userid - [Integer] The ID of user who posed the comment.
      • username
    Mon 29th Nov '10, 5:50pm
  • Bloginfo Array
    Wayne Luke
    The array contains the information of a blog entry information. It contains:
    • blog_title - [String] Blog title.
    • username - [String] Blog user name.
    • rating - [String] Blog entry rating.
    • ratingnum - [Integer] Number of blog entry ratings.
    • ratingavg - [Integer] Blog entry rating in average.
    • trackback_visible - [Boolean] Whether the trackback is visible.
    • views - [Integer] Number of views of the blog entry.
    • userid - [String] Blog user ID.
    Mon 29th Nov '10, 5:49pm
  • Blog Array
    Wayne Luke
    This array contains the information of a blog entry. It has the following items:
    • blogid - [Integer] Blog entry ID.
    • profilepicurl - [String] Blog user's profile picture URL.
    • postedby_username - [String] Blog entry poster's username.
    • avatarurl - [String] Blog user's avatar URL.
    • title - [String] Blog entry title.
    • ratingnum - [Integer] Number of blog entry ratings.
    • date - [String] Blog entry post date.
    • time - [String] Blog entry post time.
    • blogtitle - [String] Blog title.
    • message - [String] Blog entry content.
    • edit_date - [String] Blog entry last
    ...
    Mon 29th Nov '10, 5:48pm
  • Custom Profile Fields Array
    Wayne Luke
    The array contains custom profile fields for the user. Custom field array has the following items:
    • custom_field_holder - [Array] details of the custom field
      • optionalfield - [Array] If profilefield.optional = 1, it will be an array of the following items. Otherwise it will be an empty array.
        • optionalname - [String] the name of the optional field.
    • profilefield - [Array] Information of the field. Contains:
      • type - [String] Possible value: select, input, textarea, checkbox, select_multiple, radio
      • optional - [Integer] Only valid if type
    ...
    Mon 29th Nov '10, 5:46pm
Working...
X