regis

<back to all web services

FinanceAccountLateChargeJobStatusRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Status
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinanceAccountLateChargeJobStatusRequest
    {
        public virtual string authorizing_uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual Guid operation_id { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinanceAccountLateChargeJobResponse
    {
        public FinanceAccountLateChargeJobResponse()
        {
            outcomes = new List<FinanceAccountLateChargeOutcome>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Guid operation_id { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime calculation_date { get; set; }
        public virtual bool preview_only { get; set; }
        public virtual decimal? skip_exact_balance { get; set; }
        public virtual string state { get; set; }
        public virtual int? total { get; set; }
        public virtual int? current_regent_id { get; set; }
        public virtual int processed { get; set; }
        public virtual int succeeded { get; set; }
        public virtual int skipped { get; set; }
        public virtual int failed { get; set; }
        public virtual DateTime created_utc { get; set; }
        public virtual DateTime updated_utc { get; set; }
        public virtual string message { get; set; }
        public virtual bool report_available { get; set; }
        public virtual List<FinanceAccountLateChargeOutcome> outcomes { get; set; }
    }

    public partial class FinanceAccountLateChargeOutcome
    {
        public virtual int regent_id { get; set; }
        public virtual string status { get; set; }
        public virtual decimal? charge_amount { get; set; }
        public virtual string charge_status { get; set; }
        public virtual string email_status { get; set; }
        public virtual string message { get; set; }
    }

}

C# FinanceAccountLateChargeJobStatusRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"authorizing_uuid":"String","reporting_term":"String","operation_id":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}