regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}/Submit

export class AddRegistrationWithBenefitRequest
{
    public student_section_uuid: string;
    public description: string;
    public amount: number;
    public charge: number;
    public is_audit: boolean;
    public benefit_id?: number;
    public benefit_amount?: number;
    public second_benefit_id?: number;
    public second_benefit_amount?: number;

    public constructor(init?: Partial<AddRegistrationWithBenefitRequest>) { (Object as any).assign(this, init); }
}

export class AddRegistrationsAdditionalChargeSubmitRequest
{
    public rate_id: number;
    public description: string;
    public charge: number;
    public credit: number;

    public constructor(init?: Partial<AddRegistrationsAdditionalChargeSubmitRequest>) { (Object as any).assign(this, init); }
}

export class AddRegistrationsSubmitRequest
{
    public transaction_uuid: string;
    public uuid: string;
    public reporting_term: string;
    public description: string;
    public email_student: boolean;
    public registrations: AddRegistrationWithBenefitRequest[];
    public additional_term_charges: AddRegistrationsAdditionalChargeSubmitRequest[];
    public authorizing_uuid: string;

    public constructor(init?: Partial<AddRegistrationsSubmitRequest>) { (Object as any).assign(this, init); }
}

TypeScript AddRegistrationsSubmitRequest DTOs

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 /Registration/{uuid}/Add/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddRegistrationsSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <additional_term_charges>
    <AddRegistrationsAdditionalChargeSubmitRequest>
      <charge>0</charge>
      <credit>0</credit>
      <description>String</description>
      <rate_id>0</rate_id>
    </AddRegistrationsAdditionalChargeSubmitRequest>
  </additional_term_charges>
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <email_student>false</email_student>
  <registrations>
    <AddRegistrationWithBenefitRequest>
      <amount>0</amount>
      <benefit_amount>0</benefit_amount>
      <benefit_id>0</benefit_id>
      <charge>0</charge>
      <description>String</description>
      <is_audit>false</is_audit>
      <second_benefit_amount>0</second_benefit_amount>
      <second_benefit_id>0</second_benefit_id>
      <student_section_uuid>String</student_section_uuid>
    </AddRegistrationWithBenefitRequest>
  </registrations>
  <reporting_term>String</reporting_term>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</AddRegistrationsSubmitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>