IPIG's Request Submission Message

Purpose

This message provides a format in which library patrons can electronically submit requests for library material. Use of this standard message format will facilitate the automatic transformation of patrons' requests into protocol-based ILL REQUESTs when received by ILL Protocol-compliant applications.

Status

Version 1.4, issued 1 July 2004 by Janifer Gatenby, as per decisions at the IPIG meeting of March 2004.

Changes include:

Deleted:
SupplierOrder,
CreditCardOrder,
RequestOrder
Added to RequestRequirements:
SearchType,
LevelOfService
Renamed:
PreferredContactMode to ClientContactMode,
PreferredContactLanguage to ClientContactLanguage
Added definitions.

XML Schema: http://oclcpica.org/content/1409/xsd/ipigrequestsubmission_v1_4_annotated.xsd
NOTE: The definition of the elements is carried in the XML schema source display, accessible via the above link (but not in the Element Types Table below.) The source of each definition is noted. Provisional definitions include indication of who provided the definition - i.e. Janifer Gatenby (JG) or Barb Shuh (BS).

See the Attribute Types Table for the contraints assigned to attributes.

OpenURL Schemas for the Request Submission:
http://oclcpica.org/?id=1409&ln=uk

Includes schemas for
ILL Request Submission Message Referrer (Content Model Diagram)
ILL Request Submission Message Referent (Content Model Diagram)
ILL Request Submission Message Requester (Content Model Diagram)
ILL Request Submission Message Service Type (Content Model Diagram)

Element Types Table

D Type Derives From Content Content Model Attributes
E RequestSubmissionMessage
 
Elements (Authentication? , DateInfo? , RequestConditions? , ClientInfo? , AddressInfo* , ClientContactInfo? , ItemInfo? , PossibleSuppliers?)
 
E Authentication
 
Elements (RequestingSystem? , Password?)
 
E RequestingSystem
 
Type string
 
E Password
 
Type string
 
E DateInfo
 
Elements (DateOfClientRequest?)
 
E DateOfClientRequest
 
Type string
 
E RequestConditions
 
Elements (RequestRequirements+)
 
E RequestRequirements
 
Elements (ServiceRequestType? , SearchType? , ClientMaximumCost? , ClientNotesComments? , RightsInformation?)
 
E ServiceRequestType
 
Type string
 
E SearchType
 
Elements (LevelOfService , ClientNeedBeforeDate)
 
E LevelOfService
 
Type string
 
E ClientNeedBeforeDate
 
Type string
 
E ClientMaximumCost
 
Type string
 
E ClientNotesComments
 
Type string
 
E RightsInformation
 
Elements (RightsInformationType , RightsInformationValue) Country
E RightsInformationType
 
Type string
 
E RightsInformationValue
 
Type string
 
E ClientInfo
 
Elements (ClientNameStructured? , ClientStatus* , ClientProxyFor* , DepartmentSchool* , CourseNameNumber* , ClientOtherAffiliation* , ClientIdentifier* , ClientBarcode? , ClientPaymentInformation?)
 
E ClientNameStructured
 
Elements (ClientSurName? , ClientGivenName? , ClientInitials? , ClientPrefix* , ClientSuffix*)
 
E ClientSurName
 
Type string
 
E ClientGivenName
 
Type string
 
E ClientInitials
 
Type string
 
E ClientPrefix
 
Type string
 
E ClientSuffix
 
Type string
 
E ClientStatus
 
Type string
 
E ClientProxyFor
 
Type string
 
E DepartmentSchool
 
Type string
 
E CourseNameNumber
 
Type string
 
E ClientOtherAffiliation
 
Type string
 
E ClientIdentifier
 
Elements (ClientIdentifierValue) IdentifierType
E ClientIdentifierValue
 
Type string
 
E ClientBarcode
 
Type string
 
E ClientPaymentInformation
 
Elements ((AccountInstitution? , AccountNumber?) | CreditCard)*
 
E AccountInstitution
 
Type string
 
E AccountNumber
 
Type string
 
E CreditCard
 
Elements (CreditCardHolderName , CreditCardNumber , CreditCardExpiryDate) CreditCardType
E CreditCardHolderName
 
Type string
 
E CreditCardNumber
 
Type string
 
E CreditCardExpiryDate
 
Type string
 
E AddressInfo
 
Elements (PhysicalAddress | ElectronicAddress)* AddressRoleType, StartDate, EndDate
E PhysicalAddress
 
Elements (StructuredAddress)
 
E ElectronicAddress
 
Type string ElectronicAddressType
E StructuredAddress
 
Elements (Addressee? , CareOf? , LocationInBuilding? , BuildingName? , Street? , PostOfficeBox? , District? , Line1? , Line2? , Locality? , Region? , Country? , PostalCode?)
 
E Addressee
 
Type string
 
E CareOf
 
Type string
 
E LocationInBuilding
 
Type string
 
E BuildingName
 
Type string
 
E Street
 
Type string
 
E PostOfficeBox
 
Type string
 
E District
 
Type string
 
E Line1
 
Type string
 
E Line2
 
Type string
 
E Locality
 
Type string
 
E Region
 
Type string
 
E Country
 
Type string
 
E PostalCode
 
Type string
 
E ClientContactInfo
 
Elements (ClientContactMode* , ClientContactLanguage*)
 
E ClientContactMode
 
Type string
 
E ClientContactLanguage
 
Type string
 
E ItemInfo
 
Elements (Author? , Title? , UniformTitle? , SubTitle? , SponsoringBody? , PlaceOfPublication? , Publisher? , PublicationDate? , Language? , SeriesTitleNumber? , Volume? , Issue? , Edition? , ThisEditionOnly? , ReportDocumentNumber? , ArticleAuthor? , ArticleTitle? , Pagination? , ArticlePublicationDate? , DissertationThesisInformation? , CallNumber* , NationalBibliographyId? , ISBN? , ISSN? , SystemId? , BibliographicSource? , UniqueItemId? , VerificationReferenceSource? , AdditionalNumberLetters? , RequestedMaterialFormat* , RequestedMaterialLanguage? , SupplementalItemDescription?)
 
E Author
 
Type string
 
E Title
 
Type string
 
E UniformTitle
 
Type string
 
E SubTitle
 
Type string
 
E SponsoringBody
 
Type string
 
E PlaceOfPublication
 
Type string
 
E Publisher
 
Type string
 
E PublicationDate
 
Type string
 
E Language
 
Type string
 
E SeriesTitleNumber
 
Type string
 
E Volume
 
Type string
 
E Issue
 
Type string
 
E Edition
 
Type string
 
E ThisEditionOnly
 
Elements ()
 
E ReportDocumentNumber
 
Type string
 
E ArticleAuthor
 
Type string
 
E ArticleTitle
 
Type string
 
E Pagination
 
Type string
 
E ArticlePublicationDate
 
Type string
 
E DissertationThesisInformation
 
Elements (Level? , Institution? , Year?)
 
E Level
 
Type string
 
E Institution
 
Type string
 
E Year
 
Type string
 
E NationalBibliographyId
 
Elements (NationalBibliographyAuthority , NationalBibliographyNumber)
 
E NationalBibliographyAuthority
 
Type string
 
E NationalBibliographyNumber
 
Type string
 
E ISBN
 
Type string
 
E ISSN
 
Type string
 
E BibliographicSource
 
Type string
 
E UniqueItemId
 
Type string
 
E VerificationReferenceSource
 
Type string
 
E AdditionalNumberLetters
 
Type string
 
E RequestedMaterialFormat
 
Type string
 
E RequestedMaterialLanguage
 
Type string
 
E SupplementalItemDescription
 
Type string
 
E PossibleSuppliers
 
Elements (PossibleSupplier*)
 
E PossibleSupplier
 
Elements (LibraryCodeOrSymbol? , LibraryName? , SystemId? , CallNumber* , CopyNumber* , Location? , Holdings? , Availability? , Notes?)
 
E LibraryCodeOrSymbol
 
Type string
 
E LibraryName
 
Type string
 
E CopyNumber
 
Type string
 
E Location
 
Type string
 
E Holdings
 
Elements (StructuredHoldings | UnstructuredHoldings)
 
E StructuredHoldings
 
Elements (Enumeration? , Chronology?)
 
E Enumeration
 
Type string
 
E Chronology
 
Type string
 
E UnstructuredHoldings
 
Type string
 
E Availability
 
Type string
 
E Notes
 
Type string
 
E SystemId
 
Elements (SystemAuthority , SystemNumber)
 
E SystemAuthority
 
Type string
 
E SystemNumber
 
Type string
 
E CallNumber
 
Type string
 



Attribute Types Table

Attribute Name Element Data Type Constraints Default Required
ElectronicAddressType ElectronicAddress NMTOKEN Pager | Fax | Telephone | URL
 
X
AddressRoleType AddressInfo NMTOKEN ShipTo | DeliverTo | BillTo | PickupAddress | NotificationAddress | Home | Work
 
X
StartDate AddressInfo string
 
 
 
EndDate AddressInfo string
 
 
 
CreditCardType CreditCard string
 
 
X
IdentifierType ClientIdentifier string
 
 
X
Country RightsInformation string
 
 
X