MyAccountService
General Purpose
Retrieve information about a patron’s library account.
Requirements
Voyager 7.x and higher.
Input Parameters
| Parameter | Description | Value | Default | Required |
|---|---|---|---|---|
| patronId | Patron ID from Patron table | integer | None | Yes |
| patronHomeUbId | Home Database ID | string | None | Yes |
Parameters are included in the invoking URL.
Input URL Syntax
This web service can be called by GET or POST methods. If it is called by GET method, include these two parameters in the URL. Substitute XXXX with the patron id and YYYY with the patron home UB id.
http://server:port/vxws/MyAccountService?patronId=XXXX&patronHomeUbId=YYYY
XSD
Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema
Input XML Example
For POST method, this service expects to receive a ServiceParametersDocument containing a patronIdentifier. Within patronIdentifier, the following parameters must be included:
- patronId – an identifier of the patron from whom information is requested
- patronHomeUbId – an identifier of the patron’s home cluster/database
- authFactor type – indicates the factor used for patron authentication. Valid values are: B(Barcode), I(Institution Id), or S(Social Security Number).
Example:
<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
<ser:parameters/>
<ser:patronIdentifier lastName="LastName" patronHomeUbId="1@DB" patronId="562">
<ser:authFactor type="B">150</ser:authFactor>
</ser:patronIdentifier>
</ser:serviceParameters>Output XML Format
This service will return a VoyagerServiceDataDocument with account information.
Example:
<?xml version="1.0" encodng="UTF-8" ?>
<voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<serviceData isUB="false" xsi:type="myac:myAccountType" xmlns:myac="http://www.endinfosys.com/Voyager/myAccount">
<myac:borrowingBlocks>
<myac:title>Blocks</myac:title>
<myac:clusterBorrowingBlocks>
<myac:cluster>
<myac:clusterName>dev65ncdb</myac:clusterName>
<myac:ubSiteId>unknown</myac:ubSiteId>
</myac:cluster>
<myac:borrowingBlock>
<myac:blockReason>charge_limit_item_policy</myac:blockReason>
<myac:blockCount>2</myac:blockCount>
<myac:blockCode>53</myac:blockCode>
<myac:blockLimit>2</myac:blockLimit>
<myac:itemType xsi:nil="true"/>
<myac:patronGroupName>Staff</myac:patronGroupName>
</myac:borrowingBlock>
<myac:borrowingBlock>
<myac:blockReason>charge_limit_item_policy_type</myac:blockReason>
<myac:blockCount>2</myac:blockCount>
<myac:blockCode>55</myac:blockCode>
<myac:blockLimit>2</myac:blockLimit>
<myac:itemType>BOOK</myac:itemType>
<myac:patronGroupName>Staff</myac:patronGroupName>
</myac:borrowingBlock>
</myac:clusterBorrowingBlocks>
</myac:borrowingBlocks>
<myac:finesFees>
<myac:title>Current Fines/Fees</myac:title>
</myac:finesFees>
<myac:demerits>
<myac:title>Demerits</myac:title>
<myac:isDemeritsOn>false</myac:isDemeritsOn>
<myac:clusterDemerits>
<myac:cluster>
<myac:clusterName>dev65ncdb</myac:clusterName>
<myac:ubSiteId>QA20012DB20020613131313</myac:ubSiteId>
</myac:cluster>
<myac:demerit>
<myac:demeritId>2997</myac:demeritId>
<myac:demeritDate>2007-12-05T22:32:54.000Z</myac:demeritDate>
<myac:itemTitle>Guard of honor.</myac:itemTitle>
<myac:demeritType>Accrued Demerit</myac:demeritType>
<myac:amount>50.00</myac:amount>
<myac:amountTotal>50.00</myac:amountTotal>
<myac:balance>50.00</myac:balance>
<myac:balanceTotal>50.00</myac:balanceTotal>
</myac:demerit>
<myac:demerit>
<myac:demeritId>2957</myac:demeritId>
<myac:demeritDate>2007-12-05T22:30:35.000Z</myac:demeritDate>
<myac:itemTitle>Intimate papers of Colonel House, arranged as a narrative by Charles Seymour ...</myac:itemTitle>
<myac:demeritType>Demerit</myac:demeritType>
<myac:amount>50.00</myac:amount>
<myac:amountTotal>100.00</myac:amountTotal>
<myac:balance>50.00</myac:balance>
<myac:balanceTotal>100.00</myac:balanceTotal>
</myac:demerit>
<myac:demerit>
<myac:demeritId>2960</myac:demeritId>
<myac:demeritDate>2007-12-05T22:30:35.000Z</myac:demeritDate>
<myac:itemTitle>Hiroshima.</myac:itemTitle>
<myac:demeritType>Demerit</myac:demeritType>
<myac:amount>50.00</myac:amount>
<myac:amountTotal>150.00</myac:amountTotal>
<myac:balance>50.00</myac:balance>
<myac:balanceTotal>150.00</myac:balanceTotal>
</myac:demerit>
<myac:demerit>
<myac:demeritId>2922</myac:demeritId>
<myac:demeritDate>2007-05-29T22:32:09.000Z</myac:demeritDate>
<myac:itemTitle>Failure of a mission; Berlin 1937-1939, by the Right Honorable Sir Nevile Henderson.</myac:itemTitle>
<myac:demeritType>Demerit</myac:demeritType>
<myac:amount>5.00</myac:amount>
<myac:amountTotal>155.00</myac:amountTotal>
<myac:balance>3.00</myac:balance>
<myac:balanceTotal>153.00</myac:balanceTotal>
</myac:demerit>
<myac:demerit>
<myac:demeritId>2922</myac:demeritId>
<myac:demeritDate>2007-05-29T22:32:24.000Z</myac:demeritDate>
<myac:demeritType>Forgive</myac:demeritType>
<myac:post>2.00</myac:post>
<myac:balanceTotal>153.00</myac:balanceTotal>
</myac:demerit>
</myac:clusterDemerits>
</myac:demerits>
<myac:chargedItems>
<myac:title>Charged Items</myac:title>
<myac:clusterChargedItems>
<myac:cluster>
<myac:clusterName>dev65ncdb</myac:clusterName>
<myac:ubSiteId>1@QA20012DB20020613131313</myac:ubSiteId>
</myac:cluster>
<myac:permitRenewal>true</myac:permitRenewal>
<myac:chargedItem>
<myac:itemId>17365</myac:itemId>
<myac:itemBarcode>32608</myac:itemBarcode>
<myac:dueDate>2008-08-02T04:59:00.000Z</myac:dueDate>
<myac:origDueDate>2008-08-02T04:59:00.000Z</myac:origDueDate>
<myac:todaysDate>2008-08-04T22:52:28.000Z</myac:todaysDate>
<myac:title>Caravan : the assembled tales of John Galsworthy.</myac:title>
<myac:author>Galsworthy, John, 1867-1933.</myac:author>
<myac:location>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</myac:location>
<myac:callNumber>PZ3.G139 Car</myac:callNumber>
<myac:statusCode>2</myac:statusCode>
<myac:itemtype>BOOK</myac:itemtype>
</myac:chargedItem>
<myac:chargedItem>
<myac:itemId>32437</myac:itemId>
<myac:itemBarcode>68840</myac:itemBarcode>
<myac:dueDate>2008-08-15T07:00:00.000Z</myac:dueDate>
<myac:origDueDate>2008-08-02T04:59:00.000Z</myac:origDueDate>
<myac:todaysDate>2008-08-04T22:52:28.000Z</myac:todaysDate>
<myac:title>Care and feeding of animals, illustrated by Hoot von Zitzewitz.</myac:title>
<myac:author>Small, Mary Cox.</myac:author>
<myac:location>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</myac:location>
<myac:callNumber>PZ10.S699 Car</myac:callNumber>
<myac:statusCode>3</myac:statusCode>
<myac:itemtype>BOOK</myac:itemtype>
</myac:chargedItem>
</myac:clusterChargedItems>
</myac:chargedItems>
<myac:availItems>
<myac:title>Available Items</myac:title>
</myac:availItems>
<myac:requests>
<myac:title>Pending Requests</myac:title>
<myac:requestItem>
<myac:itemID>42289</myac:itemID>
<myac:holdRecallID>1491</myac:holdRecallID>
<myac:replyNote/>
<myac:status>1</myac:status>
<myac:holdType>H</myac:holdType>
<myac:itemTitle>Dinosaurs / Kate Petty ; illustrated by Richard Orr, Stephen Bennett.</myac:itemTitle>
<myac:expireDate>2008-08-29T05:00:00.000Z</myac:expireDate>
<myac:dbKey>QA20012DB20020613131313</myac:dbKey>
<myac:dbName>dev65ncdb</myac:dbName>
<myac:queuePosition>1</myac:queuePosition>
<myac:pickuplocation>Circulation Desk</myac:pickuplocation>
</myac:requestItem>
<myac:requestItem>
<myac:itemID>69854</myac:itemID>
<myac:holdRecallID>1492</myac:holdRecallID>
<myac:replyNote/>
<myac:status>1</myac:status>
<myac:holdType>H</myac:holdType>
<myac:itemTitle>Everything for fall : a complete activity book for teachers of young children : activities for September, October, and November / edited by Kathy Charner ; illustrations by Joan Waites.</myac:itemTitle>
<myac:expireDate>2008-08-29T05:00:00.000Z</myac:expireDate>
<myac:dbKey>QA20012DB20020613131313</myac:dbKey>
<myac:dbName>dev65ncdb</myac:dbName>
<myac:queuePosition>1</myac:queuePosition>
<myac:pickuplocation>Circulation Desk</myac:pickuplocation>
</myac:requestItem>
<myac:requestItem>
<myac:itemID>28010</myac:itemID>
<myac:holdRecallID>832</myac:holdRecallID>
<myac:replyNote/>
<myac:callslipStatus>7</myac:callslipStatus>
<myac:nofillReason/>
<myac:holdType>C</myac:holdType>
<myac:itemTitle>Pet show!</myac:itemTitle>
<myac:expireDate>2008-07-30T22:05:39.000Z</myac:expireDate>
<myac:dbKey>QA20012DB20020613131313</myac:dbKey>
<myac:dbName>dev65ncdb</myac:dbName>
<myac:pickuplocation>Juvenile Education Stacks</myac:pickuplocation>
</myac:requestItem>
</myac:requests>
</serviceData>
</voyagerServiceData>