Collection APIs

JSON FORMAT:

{ "collection_name" (string)

"user_id" (int)

"submitter" (string)

"owner" (string)

"cit_ids" (list of ints) }

example:

{ 
  "collection_name" : "CAPubs",
  "user_id" : 0,
  "submitter" : "tgennaro",
  "owner" : "colallen",
  "cit_ids" : [1,2,3,4,5,6] 
}

add_collection(request)

request_method = 'POST' , route_name= 'add_collection', route= '/collection/add/new'

INPUT: json_body ( request.json_body)

ACTION: inserts a new collection record into collection table

OUTPUT: returns "success" if successful

json_format example :

{
  "collection_name": "testColl3", 
  "user_id": 0, 
  "submitter": "test", 
  "owner": "raks"
}

add_citation_to_collection(request)

request_method = 'PUT' , route_name= 'add_citation_to_collection', route= '/collection/add/existing'

INPUT: json_body ( request.json_body)

ACTION: adds new citations in an existing collection by updating the member_of_collections table.

OUTPUT: returns "success" if successful

{
  "coll_id" : 23 , 
  "cit_ids": [65, 76]
}

merge_collections(request) request_method = 'POST' , route_name= 'merge_collections', route= '/collection/merge'

INPUT: json_body ( request.json_body)

ACTION: merges collection into a new collection / existing collection

OUTPUT: returns "success" if successful

json_format example :

{
  "collections_to_merge": [913,914] ,
  "pivot_collection": 912, 
  "new_collection_name": null,
  "user_id" : None
  "submitter": null
  "owner" : null
}