POST api/DEW/FRQueueFinalize

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DERNum	integer	None.
UserName	string	None.
SiteGroupNum	integer	None.
DERType	string	None.
OtherDERType	string	None.
AccountProofedFlag	boolean	None.
AddressVerifiedFlag	boolean	None.
SendIRISMsgFlag	boolean	None.
GeocodeFailedFlag	boolean	None.
SiteGroupRequestFlag	boolean	None.
EmailPDFCreated	boolean	None.
EmailHTMLBody	string	None.
SenderName	string	None.
SenderEmail	string	None.
ToRecipients	string	None.
CcRecipients	string	None.
EmailSubject	string	None.
DevNumList	Collection of integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DERNum": 1,
  "UserName": "sample string 1",
  "SiteGroupNum": 1,
  "DERType": "sample string 2",
  "OtherDERType": "sample string 3",
  "AccountProofedFlag": true,
  "AddressVerifiedFlag": true,
  "SendIRISMsgFlag": true,
  "GeocodeFailedFlag": true,
  "SiteGroupRequestFlag": true,
  "EmailPDFCreated": true,
  "EmailHTMLBody": "sample string 4",
  "SenderName": "sample string 5",
  "SenderEmail": "sample string 6",
  "ToRecipients": "sample string 7",
  "CcRecipients": "sample string 8",
  "EmailSubject": "sample string 9",
  "DevNumList": [
    1,
    1
  ],
  "SessionNum": 10,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 11",
  "StagesURL": "sample string 12"
}

application/xml, text/xml

Sample:

<FRQueueFinalizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 12</StagesURL>
  <ApplicationCode>sample string 11</ApplicationCode>
  <SessionNum>10</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <AccountProofedFlag>true</AccountProofedFlag>
  <AddressVerifiedFlag>true</AddressVerifiedFlag>
  <CcRecipients>sample string 8</CcRecipients>
  <DERNum>1</DERNum>
  <DERType>sample string 2</DERType>
  <DevNumList xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </DevNumList>
  <EmailHTMLBody>sample string 4</EmailHTMLBody>
  <EmailPDFCreated>true</EmailPDFCreated>
  <EmailSubject>sample string 9</EmailSubject>
  <GeocodeFailedFlag>true</GeocodeFailedFlag>
  <OtherDERType>sample string 3</OtherDERType>
  <SendIRISMsgFlag>true</SendIRISMsgFlag>
  <SenderEmail>sample string 6</SenderEmail>
  <SenderName>sample string 5</SenderName>
  <SiteGroupNum>1</SiteGroupNum>
  <SiteGroupRequestFlag>true</SiteGroupRequestFlag>
  <ToRecipients>sample string 7</ToRecipients>
  <UserName>sample string 1</UserName>
</FRQueueFinalizeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FRQueueDeleteResult

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
FRQueueDelete	Collection of pFRQueueDeleteResult	None.
AddressVerifiedFlag	boolean	None.
SendIRISMsgFlag	boolean	None.
GeocodeFailedFlag	boolean	None.
AccountProofed	boolean	None.
NotLockedFlag	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "FRQueueDelete": [
    {
      "DER___required": "sample string 1"
    },
    {
      "DER___required": "sample string 1"
    }
  ],
  "AddressVerifiedFlag": true,
  "SendIRISMsgFlag": true,
  "GeocodeFailedFlag": true,
  "AccountProofed": true,
  "NotLockedFlag": true
}

application/xml, text/xml

Sample:

<FRQueueDeleteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <AccountProofed>true</AccountProofed>
  <AddressVerifiedFlag>true</AddressVerifiedFlag>
  <ErrorMessage>sample string 2</ErrorMessage>
  <FRQueueDelete xmlns:d2p1="http://schemas.datacontract.org/2004/07/RapidAPI">
    <d2p1:pFRQueueDeleteResult>
      <d2p1:DER___required>sample string 1</d2p1:DER___required>
    </d2p1:pFRQueueDeleteResult>
    <d2p1:pFRQueueDeleteResult>
      <d2p1:DER___required>sample string 1</d2p1:DER___required>
    </d2p1:pFRQueueDeleteResult>
  </FRQueueDelete>
  <GeocodeFailedFlag>true</GeocodeFailedFlag>
  <NotLockedFlag>true</NotLockedFlag>
  <SendIRISMsgFlag>true</SendIRISMsgFlag>
  <Success>true</Success>
</FRQueueDeleteResult>