regis

<back to all web services

FinanceAccountLateChargeJobStartRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs
FinanceAccountLateChargeJobStartRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
reporting_termpathstringNo
operation_idbodyGuidNo
calculation_datebodyDateTimeNo
preview_onlybodyboolNo
skip_exact_balancebodydecimal?No
send_emailsbodyboolNo
FinanceAccountLateChargeJobResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
operation_idformGuidNo
reporting_termformstringNo
calculation_dateformDateTimeNo
preview_onlyformboolNo
skip_exact_balanceformdecimal?No
stateformstringNo
totalformint?No
current_regent_idformint?No
processedformintNo
succeededformintNo
skippedformintNo
failedformintNo
created_utcformDateTimeNo
updated_utcformDateTimeNo
messageformstringNo
report_availableformboolNo
outcomesformList<FinanceAccountLateChargeOutcome>No
FinanceAccountLateChargeOutcome Parameters:
NameParameterData TypeRequiredDescription
regent_idformintNo
statusformstringNo
charge_amountformdecimal?No
charge_statusformstringNo
email_statusformstringNo
messageformstringNo

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

HTTP + CSV

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

POST /Finance/AccountLate/{reporting_term}/Jobs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"authorizing_uuid":"String","reporting_term":"String","operation_id":"00000000000000000000000000000000","calculation_date":"0001-01-01T00:00:00.0000000","preview_only":false,"skip_exact_balance":0,"send_emails":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"operation_id":"00000000000000000000000000000000","reporting_term":"String","calculation_date":"0001-01-01T00:00:00.0000000","preview_only":false,"skip_exact_balance":0,"state":"String","total":0,"current_regent_id":0,"processed":0,"succeeded":0,"skipped":0,"failed":0,"created_utc":"0001-01-01T00:00:00.0000000","updated_utc":"0001-01-01T00:00:00.0000000","message":"String","report_available":false,"outcomes":[{"regent_id":0,"status":"String","charge_amount":0,"charge_status":"String","email_status":"String","message":"String"}]}