[HTTP GET] ~/contacts/{contactId}/webforms

Description: Get a list of a Contact's WebForm Interactions

Request Information

ODATA Queryable

URI Parameters

NameDescriptionTypeAdditional information
contactId

Encrypted Contact Id

 string

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A collection of ContactWebFormDTO

Response Content : Collection of ContactWebForm

NameDescriptionTypeAdditional information
Id

The Webform's ID

 integer

None.
LandingPageId

The Id of the landing page the webform is embedded in

 integer

None.
Name

The Name of the Webform

 string

None.
Date

The date of the interaction

 date

None.
Submitted

Was the Webform Submitted?

 integer

None.

Response Codes:

  • 200 - OK
    • The specified Contact's Webform Interactions were retrieved and returned successfully.
  • 401 - Unauthorized
    • Request has been denied as it lacks valid Authentication credentials.
  • 403 - Forbidden
    • The user does not have the relevant permissions to perform this action.
  • 404 - NotFound
    • The specified Contact was not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "LandingPageId": 1,
    "Name": "sample string 1",
    "Date": "2024-05-06T03:26:48.785943+01:00",
    "Submitted": 3
  },
  {
    "Id": 1,
    "LandingPageId": 1,
    "Name": "sample string 1",
    "Date": "2024-05-06T03:26:48.785943+01:00",
    "Submitted": 3
  }
]

application/csp-report

Sample: 
[{"Id":1,"LandingPageId":1,"Name":"sample string 1","Date":"2024-05-06T03:26:48.785943+01:00","Submitted":3},{"Id":1,"LandingPageId":1,"Name":"sample string 1","Date":"2024-05-06T03:26:48.785943+01:00","Submitted":3}]

application/xml, text/xml

Sample: 
<ArrayOfContactWebForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts">
  <ContactWebForm>
    <Date>2024-05-06T03:26:48.785943+01:00</Date>
    <Id>1</Id>
    <LandingPageId>1</LandingPageId>
    <Name>sample string 1</Name>
    <Submitted>3</Submitted>
  </ContactWebForm>
  <ContactWebForm>
    <Date>2024-05-06T03:26:48.785943+01:00</Date>
    <Id>1</Id>
    <LandingPageId>1</LandingPageId>
    <Name>sample string 1</Name>
    <Submitted>3</Submitted>
  </ContactWebForm>
</ArrayOfContactWebForm>