POST api/Contacts
Make a contact request
Request Information
URI Parameters
None.
Body Parameters
The ContactRequest
ContactRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Full name of end user |
string |
None. |
| EMailAddress |
EMailAddress of end user |
string |
None. |
| PhoneNumber |
PhoneNumber of end user |
string |
None. |
| PreferredMethodContact |
The Preferred Method that we may Contact the end user |
string |
None. |
| MessageSubject |
The subject of the message (reason of request to contact) |
string |
None. |
| Message |
The message (reason of request to contact) |
string |
None. |
| Lang2 |
The default language of this contact request, |
string |
None. |
| Website |
The website of the end users organisation |
string |
None. |
| Consent |
The end user consent |
boolean |
None. |
Request Formats
application/json, text/json
{
"Name": "sample string 1",
"EMailAddress": "sample string 2",
"PhoneNumber": "sample string 3",
"PreferredMethodContact": "sample string 4",
"MessageSubject": "sample string 5",
"Message": "sample string 6",
"Lang2": "sample string 7",
"Website": "sample string 8",
"Consent": true
}
application/xml, text/xml
<ContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO"> <Consent>true</Consent> <EMailAddress>sample string 2</EMailAddress> <Lang2>sample string 7</Lang2> <Message>sample string 6</Message> <MessageSubject>sample string 5</MessageSubject> <Name>sample string 1</Name> <PhoneNumber>sample string 3</PhoneNumber> <PreferredMethodContact>sample string 4</PreferredMethodContact> <Website>sample string 8</Website> </ContactRequest>
Response Information
Resource Description
The response of a contact request
ContactResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestProcessed |
If the contact request has been successfully processed |
boolean |
None. |
| Message01 |
Message 1 back to end user |
string |
None. |
| Message02 |
Message 2 back to end user |
string |
None. |
| Message03 |
Message 3 back to end user |
string |
None. |
Response Formats
application/json, text/json
{
"RequestProcessed": true,
"Message01": "sample string 2",
"Message02": "sample string 3",
"Message03": "sample string 4"
}
application/xml, text/xml
<ContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO"> <Message01>sample string 2</Message01> <Message02>sample string 3</Message02> <Message03>sample string 4</Message03> <RequestProcessed>true</RequestProcessed> </ContactResponse>