POST api/FormDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Post form

Request Information

URI Parameters

Name	Type	Additional information
VendorID	string	Required
VendorPassword	string	Required
APIGUID	string	Required

Body Parameters

Class structure for sending form

SendForm

Name	Type	Additional information
WebFormKey	integer	None.
CompanyKey	integer	None.
ResidentContactKey	integer	None.
ParentKey	integer	None.
EmailTo	string	None.
FormDetailList	Collection of SendFormDetail	None.
Attachments	Collection of Attachment	None.

Request Formats

application/json, text/json

Sample:

{
  "WebFormKey": 1,
  "CompanyKey": 2,
  "ResidentContactKey": 3,
  "ParentKey": 4,
  "EmailTo": "sample string 5",
  "FormDetailList": [
    {
      "WebFormDetailKey": 1,
      "DetailValue": "sample string 2"
    },
    {
      "WebFormDetailKey": 1,
      "DetailValue": "sample string 2"
    }
  ],
  "Attachments": [
    {
      "FileName": "sample string 1",
      "ImageBase64": "sample string 2"
    },
    {
      "FileName": "sample string 1",
      "ImageBase64": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SendForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesForm">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesCommunicationRequest">
    <d2p1:Attachment>
      <d2p1:FileName>sample string 1</d2p1:FileName>
      <d2p1:ImageBase64>sample string 2</d2p1:ImageBase64>
    </d2p1:Attachment>
    <d2p1:Attachment>
      <d2p1:FileName>sample string 1</d2p1:FileName>
      <d2p1:ImageBase64>sample string 2</d2p1:ImageBase64>
    </d2p1:Attachment>
  </Attachments>
  <CompanyKey>2</CompanyKey>
  <EmailTo>sample string 5</EmailTo>
  <FormDetailList>
    <SendFormDetail>
      <DetailValue>sample string 2</DetailValue>
      <WebFormDetailKey>1</WebFormDetailKey>
    </SendFormDetail>
    <SendFormDetail>
      <DetailValue>sample string 2</DetailValue>
      <WebFormDetailKey>1</WebFormDetailKey>
    </SendFormDetail>
  </FormDetailList>
  <ParentKey>4</ParentKey>
  <ResidentContactKey>3</ResidentContactKey>
  <WebFormKey>1</WebFormKey>
</SendForm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.