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.3, issued 29 April 2003

Changes:
AddressInfo is now optional and repeatable.
Unstructured elements for names and address elements have been deleted.

XML Schema:
To download*: http://www.nlc-bnc.ca/iso/ill/document/ipigwp/ipigrequestsubmission_v1_3.xsd
* Note: To download the XML Schema, hover over the "download" link, click on the right-hand button, and select the save command, variously called "Save Target As" or "Save Link As".

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? , ClientNeedBeforeDate? , ClientMaximumCost? , ClientNotesComments? , RightsInformation?) RequestOrder
E ServiceRequestType
 
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, CreditCardOrder
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 (PreferredContactMode* , PreferredContactLanguage*)
 
E PreferredContactMode
 
Type string
 
E PreferredContactLanguage
 
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?) SupplierOrder
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
 



Back to Implementors Page, ILL ASMA website

Element Table and Content Model Diagrams produced using XML Authority.