change_assignment_quantity: Change assignment quantity

View source: R/assignments.R

change_assignment_quantityR Documentation

Change assignment quantity

Description

Change the quantity for the target assignment.

Usage

change_assignment_quantity(
  id,
  quantity,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

id

Numeric. Assignment ID number

quantity

Numeric. New quantity of interviews to collect for this assignment.

server

Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)

workspace

Character. Name of the workspace whose assignments to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.

user

Character. API user name

password

Character. API password

Details

Wrapper for ⁠PATCH ​/api​/v1​/assignments​/{id}​/changeQuantity⁠

Value

Server-side side-effect of changing assignment quantity.


arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.