POST api/ProductWebsite/SubmitOrder

Request Information

URI Parameters

None.

Body Parameters

StudentOrders
NameDescriptionTypeAdditional information
UserAccountSettingId

integer

None.

UserEmailVerificationId

integer

None.

StudentId

integer

None.

StudentOrderId

integer

None.

StudentDetails

StudentDetails

None.

ProductsList

Collection of StudentProducts

None.

StudentProductShipments

StudentProductShipments

None.

Result

ReturnResult

None.

ShippingDetails

OrderShippingDetails

None.

TotalAmount

decimal number

None.

TotalAddonAmount

decimal number

None.

StudentPurchaseSetId

integer

None.

IsAdminRegistration

boolean

None.

CorporateTotalAmount

decimal number

None.

TaxAmount

decimal number

None.

IsCollectTax

boolean

None.

IsCollectShippingCost

boolean

None.

ShippingTypeId

integer

None.

ShippingAmount

decimal number

None.

CorporateShippingAmount

decimal number

None.

IsTaxAmountCalculated

boolean

None.

OrderedOn

date

None.

OrderedBy

integer

None.

OrderedByUserType

string

None.

EntryType

string

None.

CorporateInfo

CorporateInfo

None.

PaymentInfo

StudentPaymentInfo

None.

ProcessPaymentImmediately

boolean

None.

PaymentInfoEntersByStudent

boolean

None.

PaymentResponseMessage

string

None.

OrderPlacedSuccessfully

boolean

None.

OrderFailedMessage

string

None.

CompanyName

string

None.

IpAddress

string

None.

IsProceed

boolean

None.

IMSDiscipline

string

None.

FeeAdjustmentList

Collection of StudentsFeeAdjustments

None.

FeeAdjustmentLogList

Collection of StudentFeeAdjustmentLog

None.

IsCommitTax

boolean

None.

ImmediatePaymentId

integer

None.

ImmediatePaymentIds

Collection of integer

None.

LaterPaymentId

integer

None.

PolicyInformation

PolicyInformation

None.

IsUpgraded

boolean

None.

UpgradedBy

string

None.

IsShippable

boolean

None.

PromocodeDiscount

PromocodeDiscount

None.

CancelRegistrationId

string

None.

IsDifferentCenter

boolean

None.

PreviewRegistrationId

integer

None.

IsTaxable

boolean

None.

IsHavingPromoCode

boolean

None.

HaveFreeProductWhileApplyPromo

boolean

None.

PayablebyCorporate

decimal number

None.

TaxAmountPayablebyCorporate

decimal number

None.

TaxAmountPayablebyStudent

decimal number

None.

PayablebyStudent

decimal number

None.

IsCorporateCodeValidated

boolean

None.

IsCorporateApplicableForAllCourse

boolean

None.

CorporateResponseMessage

string

None.

IsPreviewCancelled

boolean

None.

isFromTransfer

boolean

None.

isOrderShipped

boolean

None.

isOrderShippingDetailsExists

boolean

None.

ImmediateProcessAmount

decimal number

None.

AffirmPaymentMessage

string

None.

CorporateCodeDetails

CorporateCodeInfo

None.

ContactInfo

StudentContactInfo

None.

PurchasedProductsList

Collection of StudentProducts

None.

PreviewRegistrationDetails

RegistrationDetails

None.

OrderMailSuccessfully

boolean

None.

StudentCartItems

Collection of StudentCartItems

None.

IsSwapRequired

boolean

None.

SwapStudentProductId

integer

None.

SwapRegistrationId

integer

None.

SwapPaymentIds

Collection of integer

None.

FromPage

string

None.

IsFromUpgradePreviousPage

boolean

None.

CorporateTaxAmount

which holds the corporate tax amount for the order

decimal number

None.

isFromAddonsPage

Gets or sets the is from addon page

boolean

None.

AlreadyPurchasedProcessedAmount

Gets or sets the addon already purchased item

decimal number

None.

FormattedStandardShipping

Gets or sets the standard shipping

string

None.

FormattedtwoShipping

Gets or sets the two day shipping

string

None.

AffirmImmediateProcessAmount

Gets or sets the two day shipping

decimal number

None.

UserResponseMessage

Gets or sets the response message for user

AppResponseMessage

None.

CorporateProductsList

Collection of StudentProducts

None.

CorporateOfferedProducts

Collection of StudentProducts

None.

IsCorporateCodeRemoved

boolean

None.

IsEnabledToCombineSheerIdWithPromo

boolean

None.

IsFromMobile

Gets or sets the is from mobile or not

boolean

None.

_session

SessionData

None.

studentProductShipments

StudentProductShipments

None.

ShippingTypes

used to get the shipping type

Collection of SelectListItem

None.

PromocodeFreeProductMessage

string

None.

IsFromPracticePortal

boolean

None.

AddressFormat

CountryAddressFormat

None.

RequestFrom

string

None.

ErrorResponse

string

None.

AvalaraInvalidAddressMsg_Mobile

string

None.

IsPolicyAccepted

boolean

None.

IsTaxExempted

boolean

None.

ShippingItemCode

string

None.

ShippingTaxAmount

decimal number

None.

IsTransferred

boolean

None.

SwapDiscountAmount

decimal number

None.

TaxExemptionDetailId

integer

None.

IsOldOrderTaxExempted

boolean

None.

IsIgnoreAVS

boolean

None.

SSOIssuer

string

None.

AccountID

string

None.

SubTotal

decimal number

None.

ListOrderShipment

Collection of OrderShipment

None.

CalculatedGrandTotalAmount

decimal number

None.

IsCorporatePayments

boolean

None.

IsToVerifyStudentDiscount

boolean

None.

IsToVerifyMilitaryDiscount

boolean

None.

IsSheerIdAlreadyVerified

string

None.

SheerIdVerificationid

string

None.

isPendingDue

boolean

None.

PromoORsheerIdDiscountReappliedMessage

string

None.

IsShowCorpCloseIcon

boolean

None.

SpecialDiscountList

Collection of SelectListItem

None.

SheerIddiscountdetails

Collection of SheerIddiscountdetails

None.

ExcludeDiscountsRequiredVerification

boolean

None.

IsFromPaymentConfirmation

boolean

None.

UTMParams

string

None.

ListStudentOrderItemTaxInfo

Collection of StudentOrderItemTaxInfo

None.

CurrentRegistrationId

integer

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'ImsApi.Models.StudentsFeeAdjustments'. Path 'ProductsList[0].FeeAdjustmentList[0].StudentFeeAdjustmentList'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'ImsApi.Models.StudentsFeeAdjustments'. Path 'ProductsList[0].FeeAdjustmentList[0].StudentFeeAdjustmentList'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'StudentOrders'.

Response Information

Resource Description

ReturnResult
NameDescriptionTypeAdditional information
Status

boolean

None.

Message

string

None.

AdditionalData

Object

None.

ObjAppResponseMessage

Gets or sets the mobile App response message

AppResponseMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "Message": "sample string 2",
  "AdditionalData": {},
  "ObjAppResponseMessage": {
    "Status": true,
    "Message": "sample string 2",
    "AdditionalData": "sample string 3"
  }
}