R/set_batch_template.R

In captr: Client for the Captricity API

#' Assign Template ID to a Batch
#' 
#' To digitize documents, create a template using the Captricity Web UI at \url{https://shreddr.captricity.com/job/} 
#' The template tells Captricity which data to get from where in the document.
#' Set the relevant document id using this function
#' 
#' @param batch_id Batch ID
#' @param template_id ID for the template
#' 
#' @export
#' 
#' @references \url{https://shreddr.captricity.com/developer/}
#' 
#' @examples \dontrun{
#' set_batch_template("batch_id", template_id)
#' }

set_batch_template <- function(batch_id = "", template_id = "") {

  captr_CHECKAUTH()

  if ( is.null(template_id) | identical(template_id, "")) stop("Provide a Valid Template ID.")
  if ( is.null(batch_id) | identical(batch_id, "")) stop("Provide a Valid Batch ID.")

  h <- new_handle()
  handle_setopt(h,  customrequest = "PUT")
  handle_setheaders(h, "Captricity-API-Token" = Sys.getenv('CaptricityToken'))
  handle_setform(h, documents = as.character(template_id))

  tag_con  <- curl_fetch_memory(paste0("https://shreddr.captricity.com/api/v1/batch/", batch_id), handle = h)
  tag      <- rawToChar(tag_con$content)

  status   <- ifelse(tag_con$status_code == 200, "Successfully Assigned", "Problem with the request")

  print(status)

  tag
}