Service Schemas > Circulation service

Circulation service

<?xml version="1.0"?>
<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns="http://schemas.sirsidynix.com/symws/circulation"
    xmlns:common="http://schemas.sirsidynix.com/symws/common"
    attributeFormDefault="qualified" elementFormDefault="qualified"
    targetNamespace="http://schemas.sirsidynix.com/symws/circulation">
  <xs:import namespace="http://schemas.sirsidynix.com/symws/common"
    schemaLocation="common.xsd"/>

  <!-- messages -->

  <!-- Even though it is possible to mix payments with applied credits, it is recommended that they
       be recorded in separate requests -->
  <xs:element name="RecordPaymentsRequest">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="billUserID" type="xs:string" minOccurs="1" maxOccurs="1" />
        <xs:element name="billKey" type="xs:int" minOccurs="1" maxOccurs="unbounded" />
        <xs:element name="feePayment" type="FeePayment" minOccurs="1" maxOccurs="unbounded"/>
        <!-- selfPaid defaults to false if not provided -->
        <xs:element name="selfPaid" type="xs:boolean" minOccurs="0" maxOccurs="1" />
        <!-- If true, paid at library will be set to billing library -->
        <!-- Defaults to false if not specified -->
        <xs:element name="paidAtBillingLibrary" type="xs:boolean" minOccurs="0" maxOccurs="1" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name="RecordPaymentsResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="feePaymentRecorded" type="FeePaymentRecorded" minOccurs="0"
          maxOccurs="unbounded" />
        <xs:element name="feePaymentProblem" type="FeePaymentProblem" minOccurs="0"
          maxOccurs="unbounded" />
        <xs:element name="netAmountRecorded" type="common:Money" minOccurs="1" maxOccurs="1" />
        <xs:element name="refundAmount" type="common:Money" minOccurs="0" maxOccurs="1" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name="CheckoutPatronInfoRequest">

 </xs:element>

  <xs:element name="CheckoutPatronInfoResponse">

  </xs:element>

  <xs:element name="CheckoutRequest">

  </xs:element>

  <xs:element name="CheckoutResponse">

  </xs:element>

  <xs:element name="LookupMailDeliveryEstimatesInfoRequest">
    <xs:complexType>
      <xs:sequence>
        <!-- if no user ID is sent, session user is used -->
        <xs:element name="userID" type="xs:string" minOccurs="0" maxOccurs="1"/>
        <xs:element name="deliveryServiceID" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name="LookupMailDeliveryEstimatesInfoResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="maiDeliveryEstimateInfo" type="MailDeliveryEstimatesInfo" minOccurs="1"
          maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name="HoldFeeRequest" />

  <xs:element name="HoldFeeResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="holdFee" type="common:Money" minOccurs="1" maxOccurs="1" />
        <xs:element name="holdFeeTax" type="common:Money" minOccurs="1" maxOccurs="1" />
        <xs:element name="totalHoldFee" type="common:Money" minOccurs="1" maxOccurs="1" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <!-- objects -->

  <xs:complexType name="FeePayment">
    <xs:sequence>
      <xs:element name="amount" type="common:Money" minOccurs="1" maxOccurs="1" />
      <xs:element name="paymentTypeID" type="xs:string" minOccurs="1" maxOccurs="1" />
      <xs:element name="vendorTransactionNumber" type="xs:string" minOccurs="0" maxOccurs="1" />
      <!-- If payment type is CREDITACCT, the Credit Reason ID must be provided. -->
      <xs:element name="creditReasonID" type="xs:string" minOccurs="0" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="FeePaymentRecorded">
    <xs:sequence>
      <xs:element name="billKey" type="xs:int" minOccurs="1" maxOccurs="1" />
      <!-- paymentTypeID may be null if there was no payment recorded -->
      <xs:element name="paymentTypeID" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="paymentTypeDescription" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="amountPaid" type="common:Money" minOccurs="1" maxOccurs="1" />
      <xs:element name="amountRemaining" type="common:Money" minOccurs="0" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="FeePaymentProblem">
    <xs:sequence>
      <xs:element name="billKey" type="xs:int" minOccurs="1" maxOccurs="1" />
      <xs:element name="problem" type="xs:string" minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="MailDeliveryEstimatesInfo">
    <xs:sequence>
      <xs:element name="deliveryServiceID" type="xs:string" minOccurs="1" maxOccurs="1" />
      <xs:element name="deliveryServiceDescription" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="estimatedShippingFee" type="common:Money" minOccurs="0" maxOccurs="1" />
      <xs:element name="estimatedShippingTime" type="xs:int" minOccurs="0" maxOccurs="1" />
      <!-- is false if no shipping cost mapping was found for delivery service associated to user’s
           library and profile settings, or if delivery service ID is not found. -->
      <xs:element name="valid" type="xs:boolean" minOccurs="1" maxOccurs="1" />
    </xs:sequence>
  </xs:complexType>

  <!-- ************ Enumerations ******************** -->
  <!-- values correspond to the Symphony server "Hold Type" enumeration -->
  <!-- Symphony Web Services only supports demand management holds which -->
  <!-- accepts only COPY or TITLE. -->
  <!-- CALL and SYSTEM are deprecated and only used for data load purposes -->
  <xs:simpleType name="HoldType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="COPY"/>
      <xs:enumeration value="TITLE"/>
      <xs:enumeration value="CALL"/>
      <xs:enumeration value="SYSTEM" />
    </xs:restriction>
  </xs:simpleType>

  <!-- values correspond to the Symphony server "Hold Range" enumeration -->
  <!-- Hold Range only applies when the Hold Type is "TITLE" -->
  <xs:simpleType name="HoldRange">
    <xs:restriction base="xs:string">
      <xs:enumeration value="LIBRARY"/>
      <xs:enumeration value="GROUP"/>
      <xs:enumeration value="SYSTEM"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="CheckoutHistoryRule">
    <xs:restriction base="xs:string">
      <xs:enumeration value="NOHISTORY" />
      <xs:enumeration value="CIRCRULE" />
      <xs:enumeration value="ALLCHARGES" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="FeeInfoFilter">
    <xs:restriction base="xs:string">
      <xs:enumeration value="UNPAID_FEES" />
      <xs:enumeration value="UNPAID_FEES_AND_PAYMENTS" />
      <xs:enumeration value="PAID_FEES" />
      <xs:enumeration value="PAID_FEES_AND_PAYMENTS" />
      <xs:enumeration value="ALL_FEES" />
      <xs:enumeration value="ALL_FEES_AND_PAYMENTS" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="CheckoutInfoFilter">
    <xs:restriction base="xs:string">
      <xs:enumeration value="ALL" />
      <xs:enumeration value="ALLEXCEPTLOST" />
      <xs:enumeration value="ALLEXCEPTCLAIMEDRETURNED" />
      <xs:enumeration value="CLAIMEDRETURNED" />
      <xs:enumeration value="LOST" />
      <xs:enumeration value="OVERDUE" />
      <xs:enumeration value="RENEWED" />
      <xs:enumeration value="RECALLED" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="HoldInfoFilter">
    <xs:restriction base="xs:string">
      <xs:enumeration value="ALL" />
      <xs:enumeration value="AVAILABLE" />
      <xs:enumeration value="COUNT_ONLY" />
      <xs:enumeration value="ACTIVE" />
      <xs:enumeration value="INACTIVE" />
      <xs:enumeration value="RECALLED" />
      <xs:enumeration value="RESERVE" />
      <xs:enumeration value="UNAVAILABLE" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="HoldInactiveType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="HOLD_INACTIVE_REASON_NONE" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_FILLED" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_CANCELLED" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_EXPIRED" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_CANCELLED_ON_RESERVE" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_BLANKET_NONEED" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_CANCELLED_ON_ORDER" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_MODIFIED_ORDER" />
      <xs:enumeration value="HOLD_INACTIVE_REASON_EXP_ONSHLF" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="StatusType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="BARRED" />
      <xs:enumeration value="BLOCKED" />
      <xs:enumeration value="DELINQUENT" />
      <xs:enumeration value="OK" />
    </xs:restriction>
  </xs:simpleType>

</xs:schema>

 


© 2009-2012 SirsiDynix