Budget funds response details

Examples:

The following examples demonstrate the different operations that can be executed on budget funds using HTTP methods.  The budget funds service can return data in two possible formats.

GET a collection of budget funds:

Request:

https://acq.sd00.worldcat.org/budgets/BP-2012-22/funds?

XML Response:

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
  <id>info:OCLC/Platform/Service</id>
  <title type="text">OCLC Platform Service Results</title>
  <link href="https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds?inst=128807&principalID=8eaa9f92-3951-431c-975a-d7df26b8d131&principalIDNS=urn:oclc:wms:da" rel="self" />
  <updated>2012-08-03T13:21:01.557Z</updated>
  <os:totalResults>10</os:totalResults>
  <os:startIndex>1</os:startIndex>
  <os:itemsPerPage>10</os:itemsPerPage>
  <entry xmlns:gd="http://schemas.google.com/g/2005">
    <title type="text">Reserves</title>
    <id>https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES</id>
    <link href="https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES" rel="self" type="application/atom+xml" />
    <updated>2012-08-03T13:21:01.559Z</updated>
    <content type="application/xml">
      <fund xmlns="http://worldcat.org/xmlschemas/Acquisitions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/Acquisitions http://worldcat.org/xmlschemas/Acquisitions/1.1/Acquisitions-1.1-fund.xsd">
        <id>7a937d5e-0491-422f-824e-42d709f44253</id>
        <fundName>Reserves</fundName>
        <fundCode>RES</fundCode>
        <level>1</level>
        <path />
        <budgeted>5000.00</budgeted>
        <encumbered>0.00</encumbered>
        <paid>0.00</paid>
        <totalBudgeted>5000.00</totalBudgeted>
        <totalEncumbered>0.00</totalEncumbered>
        <totalPaid>0.00</totalPaid>
        <remainingBalance>5000.00</remainingBalance>
        <budget>
          <link rel="self" href="https://acq.sd00.worldcat.org/budgets/BP-2012-1" type="application/atom+xml" />
          <title>2012-2013 (1 Year)</title>
          <startDate>2012-03-08</startDate>
          <endDate>2013-03-07</endDate>
        </budget>
        <subFunds />
      </fund>
    </content>
    <gd:etag>ffbde3af64aa12d552704f346cc5a134</gd:etag>
  </entry>
  ....
</feed>

JSON Response:

{
 "id":"info:OCLC/Platform/Service",
 "title":"OCLC Platform Service Results",
 "updated":"2012-08-03T13:20:29.308Z",
 "links":[{
   "href":"https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds?inst=128807&principalID=8eaa9f92-3951-431c-975a-d7df26b8d131&principalIDNS=urn:oclc:wms:da",
   "rel":"self"
  }
 ],
 "entries":[{
   "id":"https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES",
   "title":"Reserves",
   "content":{"subFunds":{"subFunds":[]},"id":"7a937d5e-0491-422f-824e-42d709f44253","path":"","level":"1","fundName":"Reserves","fundCode":"RES","budgeted":"5000.00","encumbered":"0.00","paid":"0.00","totalBudgeted":"5000.00","totalEncumbered":"0.00","totalPaid":"0.00","remainingBalance":"5000.00","budget":{"link":{"type":"application/atom+xml","href":"https://acq.sd00.worldcat.org/budgets/BP-2012-1","rel":"self"},"title":"2012-2013 (1 Year)","startDate":"2012-03-08","endDate":"2013-03-07"},"etag":"ffbde3af64aa12d552704f346cc5a134"},
   "updated":"2012-08-03T13:20:29.318Z",
   "links":[{
     "href":"https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES",
     "rel":"self",
     "type":"application/atom+xml"
    }
   ],
   ...
   "extensions":[{
     "name":"gd:etag",
     "attributes":{
      "xmlns:gd":"http://schemas.google.com/g/2005"
     },
     "children":["c13815152703cf4ab99522c5eab2f145"
     ]
    }
   ]
  }
 ],
 "extensions":[{
   "name":"os:totalResults",
   "attributes":{
    "xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
   },
   "children":["10"
   ]
  },{
   "name":"os:startIndex",
   "attributes":{
    "xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
   },
   "children":["1"
   ]
  },{
   "name":"os:itemsPerPage",
   "attributes":{
    "xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
   },
   "children":["10"
   ]
  }
 ]
}

GET a budget fund by ID:

Request:

https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES

Response:

<entry xmlns:gd="http://schemas.google.com/g/2005">
    <title type="text">Reserves</title>
    <id>https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES</id>
    <link href="https://acq.sd00.worldcat.org/budgets/BP-2012-1/funds/RES" rel="self" type="application/atom+xml" />
    <updated>2012-08-03T13:21:01.559Z</updated>
    <content type="application/xml">
      <fund xmlns="http://worldcat.org/xmlschemas/Acquisitions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/Acquisitions http://worldcat.org/xmlschemas/Acquisitions/1.1/Acquisitions-1.1-fund.xsd">
        <id>7a937d5e-0491-422f-824e-42d709f44253</id>
        <fundName>Reserves</fundName>
        <fundCode>RES</fundCode>
        <level>1</level>
        <path />
        <budgeted>5000.00</budgeted>
        <encumbered>0.00</encumbered>
        <paid>0.00</paid>
        <totalBudgeted>5000.00</totalBudgeted>
        <totalEncumbered>0.00</totalEncumbered>
        <totalPaid>0.00</totalPaid>
        <remainingBalance>5000.00</remainingBalance>
        <budget>
          <link rel="self" href="https://acq.sd00.worldcat.org/budgets/BP-2012-1" type="application/atom+xml" />
          <title>2012-2013 (1 Year)</title>
          <startDate>2012-03-08</startDate>
          <endDate>2013-03-07</endDate>
        </budget>
        <subFunds />
      </fund>
    </content>
    <gd:etag>ffbde3af64aa12d552704f346cc5a134</gd:etag>
  </entry>