Difference between revisions of "Data Submission Formats"

From ISFDB
Jump to navigation Jump to search
(Some added narrative)
Line 51: Line 51:
 
==Series Related Submissions==
 
==Series Related Submissions==
  
* [[XML:SeriesUpdate]]
+
* [[XML:SeriesUpdate]] - Updates a series record.
 +
 
 +
Note that there are no submission types to create or delete series entries. Series entries are created on demand when a title requires them. Likewise series entries are deleted when no other records refer to them (theoretically).
  
 
==Awards Related Submissions==
 
==Awards Related Submissions==
  
* [[XML:NewAward]]
+
* [[XML:NewAward]] - Creates a new award record.
* [[XML:AwardDelete]]
+
* [[XML:AwardDelete]] - Deletes an award record.
* [[XML:AwardUpdate]]
+
* [[XML:AwardUpdate]] - Deletes an award record.
  
 
==Publisher Related Submissions==
 
==Publisher Related Submissions==
  
* [[XML:PublisherUpdate]]
+
* [[XML:PublisherUpdate]] - Updates a publisher record.
* [[XML:PublisherMerge]]
+
* [[XML:PublisherMerge]] - Merges two or more publisher records.
 +
 
 +
Note that there are no submission types to create or delete publisher entries. Publisher entries are created on demand when a publication requires them. Likewise publisher entries are deleted when no other publications refer to them.
 +
 
  
 
[[Category:Data Submission Formats]]
 
[[Category:Data Submission Formats]]

Revision as of 22:40, 21 May 2008

Introduction

The data submitted to the ISFDB must be a well-formed XML string. All submissions must contain the following:

  • An xml header utilizing version 1.0, and a recommended encoding of iso-8859-1.
  • The data must be enclosed within a set of IsfdbSubmission tags.
  • The data must contain a valid registered user within a set of Submitter tags.
  • The data must contain a subject heading within a set of Subject tags. This subject is displayed in the moderator queue, and is not integrated into the ISFDB data.

A stubbed out version of a generic submission looks like this:

<?xml version="1.0" encoding="iso-8859-1" ?>
<IsfdbSubmission>
  <...Type...>
     <Submitter>Registered_User_Name</Submitter>
     <Subject>Subject Line That Will Appear in Moderator Queue</Subject>
     ...
  </...Type...>
</IsfdbSubmission>

Author Related Submissions

There are two data submission types necessary for the upkeep of the authors table:

Note that there are no submission types to create or delete author entries. Author entries are created on demand when a title or publication requires them. Likewise author entries are deleted when no other records refer to them.

Publication Related Submissions

There are four data submission types necessary for the upkeep of the pubs table:

Title Related Submissions

Series Related Submissions

Note that there are no submission types to create or delete series entries. Series entries are created on demand when a title requires them. Likewise series entries are deleted when no other records refer to them (theoretically).

Awards Related Submissions

Publisher Related Submissions

Note that there are no submission types to create or delete publisher entries. Publisher entries are created on demand when a publication requires them. Likewise publisher entries are deleted when no other publications refer to them.