A Web Resource Provided by the Experimental Electronic Press - XPEP

Structure of JIR Outcome Messages in CEL


There are two main types of outcome messages from the JIR server: result messages provide information in answer to the submitted query, and failure messages report that the query could not be answered, for example because JIR does not have information about the journal in question, or because some essential parameter was missing in the query.

Result Messages

There are a few different types of result messages depending on the query; in particular, on form for queries about prepublication and another one for queries about postpublication. A result message for a postpublication query has the general form shown here:

    [result:
        :webres cappa-res
        :type postpub-info
        :permit-posting --
        :requires-payment ---
        :reason-code ---
        :reason-phrase ---
        :caution-codes ---
        :caution-phrases ---
        :allowed-versions ---
        :disallowed-versions ---
        :required-citation ---
        :cite-url ---
        :base-information --- ]
The first two parameters are fixed and are used for system purposes. The following parameters provide the answer to the query using the following coding.

permit-posting The value shall be either of at-once, when-published, not-at-all , or of the form [month 2010 11] . The last case expresses the year and month when the article may be posted, according to an embargo restriction. The value when-published is used when the journal publisher allows the article to be parallel published after it has appeared in the journal, but not before.

requires-payment This parameter arises only if the value for permit-posting is yes or a month record. In such cases its value shall be either of no or a record such as [USD 50] specifying currency and amount.

reason-code This parameter arises only if the value for permit-posting is not-at-all and it is an explanation for the reason, expressed as a code of the form +/- followed by a two-digit number.

reason-phrase This parameter arises in the same cases as for reason-code and is a phrase explaining the meaning of the reason-code. The list of possible reason-codes and the corresponding phrases is shown below.

caution-codes The value of this optional parameter is a set of phrasecodes, similar to the reason-codes. They express particular caveats that should be taken into account by the user.

caution-phrases is similar to reason-phrases but its value is a set of strings explaining the codes occurring in the caution-codes parameter.

allowed-versions This parameter arises if posting is permitted, and its value shall be a set of symbols specifying which versions of the article may be used for posting.

disallowed-versions Similar to allowed-versions but specifies which versions may not be used. At most one of these two parameters will occur. The list of version codes follows below.

required-citation This parameter specifies what information must be displayed in the posted version of the article and/or in the web context surrounding it. The value shall either be the symbol set-phrase or a set of one or more of the following symbols:

    bibdata        Standard bibliographic metadata for the article
    publisher-cr   Publisher's copyright statement
    publisher-url  URL of publisher's 'homepage'
    article-url    URL for this specific article in the publisher's website
If the value is set-phrase then the required set phrase for use on the first page of the posted article is provided as an attachment to the result message.

cite-url This parameter may occur if the value for required-citation included publisher-url or article-url, and the value is the required URL to the publisher or the journal, if known. At present only the case of publisher-url is supported.

base-information This parameter is only used when the result needs to be checked; its value is a sub-expression like in the following example:

    {[: issn ---]
     [: journal ---]
     [: publisher ---]
     [: pubcode ---]}
The first component returns the ISSN-code parameter that was given in the request, and the following elements show which journal, which publisher, and which publisher code have been identified by JIR for this ISSN-code. The pubcode is associated with the rules for parallel publication. Usually there is one pubcode for each publisher where these rules are known, but if one publisher applies different rules for different journals then each set of rules gets its own pubcode.

Reason-codes and their Phrases

The following are the reason-codes and corresponding reason-phrases at present.

  +/-30 Postpublication not permitted on this server type
  +/-31 Parallel publication not permitted after article appears in journal
  +/-32 Parallel publication not permitted before article appears in journal

Caveat-codes and their Phrases

The following are the caveat-codes and corresponding caveat-phrases at present.

  +/-51 Month of publication missing, assumed to be December
  +/-52 Link to URL for specific article on publisher's server is required

Failure Messages

Failure messages have the general form shown in this example:

    [failure:
        :webres cappa-res
        :failure-code +/-99
        :failure-phrase "..." ]
where the value of failure-code is a phrasecode like for result messages, and the value of failure-phrase is an English-language phrase explaining the failurecode. The following failure codes are in use at present:

  +/-71 ISSN number missing in query
  +/-72 Given ISSN number does not conform to syntax required by JIR (nnnn-nnnn)
  +/-73 Unknown ISSN number
  +/-74 Publisher unknown for the journal with the given ISSN number
  +/-75 No parallel-publishing information available for publisher of this journal
  +/-76 Insufficient parallel-publishing information available for publisher of this journal
  +/-77 Category of server operator not provided in query
  +/-78 Publication year not provided in query - required in order to answer it
  +/-79 Insufficient parallel-publishing date information available for publisher of this journal


Posted on 2010-02-21 as part of the JIRSITE website.