/* strings used in administrative, and participant, pages to send requests to the server.
  These complemeht strings usedin svyUserHeaders.js and svyServerHeaders.js  */

/* getSessionDescriptorURL : the basic URL to use to request the contents of a session-dsecriptor file (an XML file).
   Note that the session name will be added at the end of this.
   Thus, if the descriptor file for the  a session named mySession is desired, and the getSessionDescriptorURL is /dsurvey/dsurvey?todo=3&name='
   then the requested URL will be:  /dsurvey/dsurvey?todo=3&name=mySession
*/
getSessionDescriptorURL='/dsurvey/dsurvey?todo=3&name=';


/* getCurrentSessionsURL: the URL that   will return a list of sessions.    */
getCurrentSessionsURL='/dsurvey/dsurvey?todo=5';

/* getCurrentSessionsURL_Latest: the URL that   will return a list of sessions, and note the "latest" session.    */
getCurrentSessionsURL_Latest='/dsurvey/dsurvey?todo=5&latest=1';

/* getSuspendedSessionsURL: the URL that   will return a list of suspended sessions.    */
getSuspendedSessionsURL='/dsurvey/dsurvey?todo=55';


/* getAllowedUsersURL: the URL that   will return an allowed_Users xml file,   
   session=sessName should be added
 */
getAllowedUsersURL='/dsurvey/dsurvey?todo=75&';


/*  submitJoinURL: the base url to submit "join a survey".
  The following will be added to th submitJoinURL
        session=sessName&id=anId&nameCheck=v01&otherVariables...
    where
        session=sessName : required. The name of the session this user is joining
        id = Semi-Optional. A client specific id (say, a random number). It is used to identify the client in the users databases.
             Some servers will use this id, others will generate one. In either case, the response from the server will be
             OK idUse  -- where "idUse" is the ID the user should use (often, the id provided by the user)
        nameCheck= Optional. If =1, then if a "name" variable exists (is part of the otherVariables), it will checked against
                   all previous joiners. If that name already has joined, an error is returned (-3 return value)
        otherVariables are optional name=Value pairs (seperated by &)

   In many cases, a "name" and a "contact" variable are specified (in the otherVariables)

   Be sure to "escape" the values!

   If success, should return 'OK idvalue'. If failure, "-error_code error message"

   Note: allowed usernames, and password checks, are done on the client side (not by the server)

   Example:   session=exp13&id=30503812&name=joe&contact=foobar@net


*/
submitJoinURL='/dsurvey/dsurvey?todo=201&';


/* getServerVarURL: the base URL used to request a "session specific" variable. 
   The following will be added to the getServerVarURL :     
       session=sessname&varname=aVarnames&delim=adelim
   where
        sessName: the survey session 
        varname: variable to be retrieved. Or, a space delimited (escaped) list of variables.
                 If varname='*', return a delim delimited list of all the server variables defined for this session, using a
                        varname=value delim varname=value ... 
                 syntax
       delim: optional. Only used if several variables. Adelim will be used by server to seperate values
  Optional: id and message variables 
        ...&delim=adelim&id=participantId&message=escaped_message&time=aTime
   This participant specific (based on participantID) message will be saved, for use in status display. In addition, the current time
   (highly recommended: use getTime()) will be stored.

*/
getServerVarURL='/dsurvey/dsurvey?todo=122&' ;


/* getServerStatusVarURL: the base URL used to request a "session specific" status variable. 
   The following will be added to the getServerStatusVarURL :     
       session=sessname&varname=aVarnames
   where
        sessName: the survey session 
        varname: variable to be retrieved. 

*/
getServerStatusVarURL='/dsurvey/dsurvey?todo=132&' ;

/* getSavedDataURL :
        retrieve a quasi-xml file containing saved data.
        The following is appended:
                sesion=sessname&type=atype
        where atype must be GENERAL, USERS, or RESULTS
*/
getSaveDataURL='/dsurvey/dsurvey?todo=461&';


/* ====== headers to static files ==== */

/* homePageURL : header to the "home page" for a instrument/session 
    All occurences of !INST! will be replaced by the instrument name
*/
homePageURL='/dsurvey/instruments/!INST!/!INST!.html';

/* instrumentBaseURL: the base url for this instruments directory 
    All occurences of !INST! will be replaced by the instrument name.
*/
instrumentBaseURL='/dsurvey/instruments/!INST!/' ;

/* specFileRL : header to the "specification file" for a instrument/session 
    All occurences of !INST! will be replaced by the instrument name.
    Relative urls will be append to the instrumentBaseURL
*/
specFileURL='specs/spec.xml';

/* getClientIdURL: get a unique client ID from the server
  session=sessname&name=myName  is added 
*/
getClientIdURL='/dsurvey/dsurvey?todo=331&' ;   



/* post a message to a client, or multiple clients, messagebox files
   session=sessname&clientList=clientIds&message=escapedMesssage 
   (if more than one clientid, seperate with a , */
messageSend='/dsurvey/dsurvey?todo=521&';

/* As above, but using POST (not GET) to transmit message */
messageSendPost='todo=521&';

/* retrieve contents of message box. Then empty the mailbox 
  session=sessname&client=clientId
*/
messageRetrieve='/dsurvey/dsurvey?todo=522&';

/* rebuild contents of a message box  (MUST use POST) 
  session=sessname&client=clientId&message=escape(multiLinesofMessages)
*/
messageRebuild='todo=523&';

