GET api/Info/GetBookVoucher?personId={personId}&term={term}

Documentation for 'GetBookVoucher'.

Request Information

Parameters

Name	Description	Additional information
personId	Documentation for 'personId'.	Define this parameter in the request URI.
term	Documentation for 'term'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "StudentId": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Term": "sample string 4",
  "VoucherTotal": 1.0,
  "OverrideTotal": 1.0,
  "SoftGoodMaximum": 1.0,
  "SupplyMaximum": 1.0,
  "UsedBookMaximum": 1.0,
  "NewBookMaximum": 1.0,
  "SponsorAmount": 1.0,
  "FundingSource": "sample string 5",
  "AdjustedBalance": 1.0,
  "Awards": [
    {
      "AwardType": "sample string 1",
      "Amount": 1.0
    },
    {
      "AwardType": "sample string 1",
      "Amount": 1.0
    },
    {
      "AwardType": "sample string 1",
      "Amount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<BookVoucher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTCAPI.Models">
  <AdjustedBalance>1</AdjustedBalance>
  <Awards>
    <Award>
      <Amount>1</Amount>
      <AwardType>sample string 1</AwardType>
    </Award>
    <Award>
      <Amount>1</Amount>
      <AwardType>sample string 1</AwardType>
    </Award>
    <Award>
      <Amount>1</Amount>
      <AwardType>sample string 1</AwardType>
    </Award>
  </Awards>
  <FirstName>sample string 2</FirstName>
  <FundingSource>sample string 5</FundingSource>
  <LastName>sample string 3</LastName>
  <NewBookMaximum>1</NewBookMaximum>
  <OverrideTotal>1</OverrideTotal>
  <SoftGoodMaximum>1</SoftGoodMaximum>
  <SponsorAmount>1</SponsorAmount>
  <StudentId>sample string 1</StudentId>
  <SupplyMaximum>1</SupplyMaximum>
  <Term>sample string 4</Term>
  <UsedBookMaximum>1</UsedBookMaximum>
  <VoucherTotal>1</VoucherTotal>
</BookVoucher>