POST api/HGInspections/SendEmailFeeReceipt

It is used to send inspection fee receipt to mentioned customers.

Request Information

URI Parameters

None.

Body Parameters

FeeReceiptModel
NameDescriptionTypeAdditional information
OrderID

It represents the OrderID of current inspection.

 integer

None.
ReportID

It represents the ReportID of current inspection.

 integer

None.
ToEmails

It represents the list of all recipients for fee receipt.

 Collection of EmailAddressModel

None.
PaymentMethod

It represents the method of payment that customer chosen.

 integer

None.
Amount

It represents the amount that customer paid through check

 decimal number

None.
CashAmount

It represents the amount that customer paid through cash

 decimal number

None.
CheckNumber

It represents the check number

 string

None.

Request Formats

application/json

Sample: 
{
  "CashAmount": 4,
  "Amount": 3,
  "ReportID": 2,
  "OrderID": 1,
  "ToEmails": [
    {
      "Email": "sample string 2",
      "DisplayName": "sample string 1"
    },
    {
      "Email": "sample string 2",
      "DisplayName": "sample string 1"
    }
  ],
  "PaymentMethod": 1,
  "CheckNumber": "sample string 5"
}

application/xml, text/xml

Sample: 
<FeeReceiptModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.Models">
  <Amount>3</Amount>
  <CashAmount>4</CashAmount>
  <CheckNumber>sample string 5</CheckNumber>
  <OrderID>1</OrderID>
  <PaymentMethod>1</PaymentMethod>
  <ReportID>2</ReportID>
  <ToEmails xmlns:d2p1="http://schemas.datacontract.org/2004/07/HomeguardApp.Communication.Entities">
    <d2p1:EmailAddressModel>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:Email>sample string 2</d2p1:Email>
    </d2p1:EmailAddressModel>
    <d2p1:EmailAddressModel>
      <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
      <d2p1:Email>sample string 2</d2p1:Email>
    </d2p1:EmailAddressModel>
  </ToEmails>
</FeeReceiptModel>

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 'FeeReceiptModel'.

Response Information

Resource Description

It is used to send inspection fee receipt to mentioned customers.

ReceiptResponseStatusModel
NameDescriptionTypeAdditional information
Status

It represents the status of current API call. status can be either "success" or "failed"

 string

None.
Message

It represents the some description about the API response.

 string

None.
IsSent

It represents whether email sent to customer or not.

 boolean

None.

Response Formats

application/json

Sample: 
{
  "IsSent": true,
  "Message": "sample string 2",
  "Status": "sample string 1"
}

application/xml, text/xml

Sample: 
<ReceiptResponseStatusModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HomeguardApp.Models">
  <IsSent>true</IsSent>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</ReceiptResponseStatusModel>