Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

catissuecore/rest/ng/sites

...

Parameter
Details
namename of the site
coordinatorCollection

Collection of user login names.Login Name through which user can login to catissue application,

should be unique in authentication domains

type

Type of site.

This attribute is should not be blank.

Permissible values are

{ }

activityStatus

Activity status of the site, permissible values are

{active, closed, pending, disabled}

streetName of street to which the site belongs.
cityCity Name of city to which the site belongs.
state [optional]State Name of the state to which the site belongs, By default it will be blank. 
countryCountry Name of the country to which the site belongs.
zipCodeZip Code of location which the site belongs.
faxNumber [optional]Fax number of the site, By default it will be blank.
phoneNumber [optional]Phone number of the site, By default it will be blank.

 

http[s]:<host>:<port>/catissuecore/rest/ng/sites

...

URLhttp://<host>:<port>/catissuecore/rest/ng/sites
MethodPOST
Requestapplication/json
json{

"name" : "Pune101",

"coordinatorCollection" : ["super@superjohn@bjc.com","site_admin@adminwashu.com"],

"type" : "Collection Site",

"activityStatus" : "Active",

"street" : "SB Road",

"city" : "Pune",

"state" : "MH",

"country" : "India" ,

"zipCode" : "412312",

"faxNumber" : "123321",

"phoneNumber" : "213434324"

}

Response

{

name"Pune101"
coordinatorCollection[2]
0:  "admin@adminjohn@bjc.com" 
1:  "super@supersite_admin@washu.com"
siteId48
type"Collection Site"
activityStatus"Active"
street"SB Road"
city"Pune"
state"MH"
country"India"
zipCode"412312"
faxNumber"123321"
phoneNumber"213434324"
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesSite has been created successfully
400All requestsInvalid parameters, e.g  duplicate Site Name, blank Site Name, blank Site Type etc
401All requestsAuthorization failed, User doesn’t have Authority
500All requestsInternal server error, Encountered server error while performing operations