Specs

add_testimonial(arg(), arg(), opts()) :: operation()

Write a new testimonial

This method requires authentication with "write" permission.

Arguments

• user_id - ID of the user the testimonial is about

• testimonial_text - The text of the testimonial. HTML/BBCode is not accepted

Example response

%{
  "stat" => "ok",
  "testimonial" => %{
    "about_user" => %{
      "is_ad_free" => "0",
      "ispro" => "0",
      "nsid" => "516314214@N05",
      "path_alias" => "stpaul",
      "realname" => "paul peterson",
      "username" => "paul"
    },
    "approved" => "0",
    "body" => "great photographer!",
    "by_user" => %{
      "is_ad_free" => "0",
      "ispro" => "1",
      "nsid" => "45937598@N01",
      "path_alias" => "",
      "realname" => "john nelson",
      "username" => "john"
    },
    "date_approved" => "0",
    "date_create" => "1491516194",
    "id" => "72157659275062162"
  }
}

Specs

approve_testimonial(arg(), opts()) :: operation()

Approve a testimonial that has been written about the currently loggedin user

This method requires authentication with "write" permission.

Arguments

• testimonial_id - ID of the testimonial to approve

Specs

delete_testimonial(arg(), opts()) :: operation()

Permanently delete a testimonial. The loggedin user must be either the author or recipient of the testimonial

This method requires authentication with "write" permission.

Arguments

• testimonial_id -

Specs

edit_testimonial(arg(), arg(), arg(), opts()) :: operation()

Change the text of a testimonial. The loggedin user must be the author of the existing testimonial. Editing a testimonial will mark it as pending and will require it to be re-approved by the recipient before appearing on their profile

This method requires authentication with "write" permission.

Arguments

• user_id - The NSID of the user the testimonial is about

• testimonial_id - The ID of the testimonial to edit

• testimonial_text - The text of the testimonial. HTML/BBCode is not accepted

Example response

%{
  "stat" => "ok",
  "testimonial" => %{
    "about_user" => %{
      "is_ad_free" => "0",
      "ispro" => "0",
      "nsid" => "516314214@N05",
      "path_alias" => "stpaul",
      "realname" => "paul peterson",
      "username" => "paul"
    },
    "approved" => "0",
    "body" => "great photographer!",
    "by_user" => %{
      "is_ad_free" => "0",
      "ispro" => "1",
      "nsid" => "45937598@N01",
      "path_alias" => "",
      "realname" => "john nelson",
      "username" => "john"
    },
    "date_approved" => "0",
    "date_create" => "1491516194",
    "id" => "72157659275062162"
  }
}

Specs

get_all_testimonials_about(opts()) :: operation()

Get all testimonials (pending and approved) written about the given user

This method requires authentication with "read" permission.

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50

Specs

get_all_testimonials_about_by(arg(), opts()) :: operation()

Get the testimonial by the currently logged-in user about the given user, regardless of approval status. Note that at most 1 testimonial will be returned

This method requires authentication with "read" permission.

Arguments

• user_id - ID of the user to get testimonials about

Specs

get_all_testimonials_by(opts()) :: operation()

Get all testimonials (pending and approved) written by the given user

This method requires authentication with "read" permission.

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50

Specs

get_pending_testimonials_about(opts()) :: operation()

Get all pending testimonials written about the given user

This method requires authentication with "read" permission.

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50

Specs

get_pending_testimonials_about_by(arg(), opts()) :: operation()

Get the pending testimonial by the currently logged-in user about the given user. Note that at most 1 testimonial will be returned

This method requires authentication with "read" permission.

Arguments

• user_id - ID of the user to get testimonials about

Specs

get_pending_testimonials_by(opts()) :: operation()

Get all pending testimonials written by the given user

This method requires authentication with "read" permission.

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50

Specs

get_testimonials_about(arg(), opts()) :: operation()

Get approved testimonials about the given user

This method does not require authentication.

Arguments

• user_id - ID of the user to get testimonials about

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50

Specs

get_testimonials_about_by(arg(), opts()) :: operation()

Get the approved testimonial by the currently logged-in user about the given user. Note that at most 1 testimonial will be returned

This method requires authentication with "read" permission.

Arguments

• user_id - ID of the user to get testimonials about

Specs

get_testimonials_by(arg(), opts()) :: operation()

Get approved testimonials written by the given user

This method does not require authentication.

Arguments

• user_id - ID of the user to get testimonials written by

Options

• page - Page number. Default is 0

• per_page - Number of testimonials to return per page. Default is 10, maximum is 50