regis

<back to all web services

TaxReceiptListRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TaxReceipt/{uuid}/List
TaxReceiptListRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
TaxReceiptsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
is_missing_tax_numberformboolNo
receiptsformList<TaxReceiptResponse>No
TaxReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
is_t4aformboolNo
is_t2202aformboolNo
yearformintNo
urlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /TaxReceipt/{uuid}/List HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TaxReceiptListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</TaxReceiptListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaxReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <is_missing_tax_number>false</is_missing_tax_number>
  <receipts>
    <TaxReceiptResponse>
      <is_t2202a>false</is_t2202a>
      <is_t4a>false</is_t4a>
      <url>String</url>
      <year>0</year>
    </TaxReceiptResponse>
  </receipts>
</TaxReceiptsResponse>