regis

<back to all web services

TaxReceiptListRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TaxReceipt/{uuid}/List
"use strict";
export class TaxReceiptResponse {
    /** @param {{is_t4a?:boolean,is_t2202a?:boolean,year?:number,url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    is_t4a;
    /** @type {boolean} */
    is_t2202a;
    /** @type {number} */
    year;
    /** @type {string} */
    url;
}
export class TaxReceiptsResponse {
    /** @param {{responseStatus?:ResponseStatus,is_missing_tax_number?:boolean,receipts?:TaxReceiptResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    is_missing_tax_number;
    /** @type {TaxReceiptResponse[]} */
    receipts;
}
export class TaxReceiptListRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript TaxReceiptListRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	is_missing_tax_number: False,
	receipts: 
	[
		{
			is_t4a: False,
			is_t2202a: False,
			year: 0,
			url: String
		}
	]
}