POST api/Survey

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
clientId	integer	None.
feedback	Collection of Feedback	None.
open_cases	Collection of Open_Cases	None.
yesterdays_closed_cases	Collection of Yesterdays_Closed_Cases	None.

Request Formats

application/json, text/json

Sample:

{
  "clientId": 1,
  "feedback": [
    {
      "type": "sample string 1",
      "survey_type": "sample string 2",
      "platform": "sample string 3",
      "scorecard_link": "sample string 4",
      "site_name": "sample string 5",
      "site_id": "sample string 6",
      "date_of_visit": "sample string 7",
      "date_feedback_added": "sample string 8",
      "review_score": 1,
      "review_max_score": 1,
      "nps_score": 1,
      "csat_score": 1,
      "blended_score": 1,
      "ratings": [
        {
          "rating": "sample string 1",
          "score": 2
        },
        {
          "rating": "sample string 1",
          "score": 2
        }
      ],
      "comments": "sample string 9",
      "staff_mention": "sample string 10",
      "incentive_voucher_sent": "sample string 11",
      "contact_requested": true,
      "guest_details": {
        "email": "sample string 1",
        "title": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4",
        "date_of_birth": "sample string 5",
        "full_address": "sample string 6",
        "postcode": "sample string 7",
        "mobile_phone": "sample string 8"
      },
      "guest_demographics": {
        "gender": "sample string 1",
        "age_range": "sample string 2",
        "visit_purpose": "sample string 3",
        "visit_frequency": "sample string 4"
      },
      "consent": {
        "marketing_consent": true,
        "consent_date": "sample string 2",
        "consent_terms_version": "sample string 3"
      },
      "questions": [
        {
          "id": 1,
          "question": "sample string 2",
          "answer": "sample string 3"
        },
        {
          "id": 1,
          "question": "sample string 2",
          "answer": "sample string 3"
        }
      ],
      "purchase": {
        "check_number": "sample string 1",
        "table_number": "sample string 2",
        "covers": 3,
        "total_spend": 4.1,
        "line_items": [
          {
            "id": "sample string 1",
            "name": "sample string 2",
            "family_group": "sample string 3",
            "major_group": "sample string 4",
            "price": 5.1,
            "quantity": 6
          },
          {
            "id": "sample string 1",
            "name": "sample string 2",
            "family_group": "sample string 3",
            "major_group": "sample string 4",
            "price": 5.1,
            "quantity": 6
          }
        ]
      }
    },
    {
      "type": "sample string 1",
      "survey_type": "sample string 2",
      "platform": "sample string 3",
      "scorecard_link": "sample string 4",
      "site_name": "sample string 5",
      "site_id": "sample string 6",
      "date_of_visit": "sample string 7",
      "date_feedback_added": "sample string 8",
      "review_score": 1,
      "review_max_score": 1,
      "nps_score": 1,
      "csat_score": 1,
      "blended_score": 1,
      "ratings": [
        {
          "rating": "sample string 1",
          "score": 2
        },
        {
          "rating": "sample string 1",
          "score": 2
        }
      ],
      "comments": "sample string 9",
      "staff_mention": "sample string 10",
      "incentive_voucher_sent": "sample string 11",
      "contact_requested": true,
      "guest_details": {
        "email": "sample string 1",
        "title": "sample string 2",
        "first_name": "sample string 3",
        "last_name": "sample string 4",
        "date_of_birth": "sample string 5",
        "full_address": "sample string 6",
        "postcode": "sample string 7",
        "mobile_phone": "sample string 8"
      },
      "guest_demographics": {
        "gender": "sample string 1",
        "age_range": "sample string 2",
        "visit_purpose": "sample string 3",
        "visit_frequency": "sample string 4"
      },
      "consent": {
        "marketing_consent": true,
        "consent_date": "sample string 2",
        "consent_terms_version": "sample string 3"
      },
      "questions": [
        {
          "id": 1,
          "question": "sample string 2",
          "answer": "sample string 3"
        },
        {
          "id": 1,
          "question": "sample string 2",
          "answer": "sample string 3"
        }
      ],
      "purchase": {
        "check_number": "sample string 1",
        "table_number": "sample string 2",
        "covers": 3,
        "total_spend": 4.1,
        "line_items": [
          {
            "id": "sample string 1",
            "name": "sample string 2",
            "family_group": "sample string 3",
            "major_group": "sample string 4",
            "price": 5.1,
            "quantity": 6
          },
          {
            "id": "sample string 1",
            "name": "sample string 2",
            "family_group": "sample string 3",
            "major_group": "sample string 4",
            "price": 5.1,
            "quantity": 6
          }
        ]
      }
    }
  ],
  "open_cases": [
    {
      "id": 1,
      "case_link": "sample string 2",
      "site_name": "sample string 3",
      "site_id": "sample string 4",
      "survey_type": "sample string 5",
      "source": "sample string 6",
      "topics": [
        "sample string 1",
        "sample string 2"
      ],
      "case_created": "sample string 7",
      "current_status": "sample string 8",
      "with_guest_since": {},
      "previous_seconds_with_guest": 10,
      "sla_seconds": 11,
      "case_closed": {}
    },
    {
      "id": 1,
      "case_link": "sample string 2",
      "site_name": "sample string 3",
      "site_id": "sample string 4",
      "survey_type": "sample string 5",
      "source": "sample string 6",
      "topics": [
        "sample string 1",
        "sample string 2"
      ],
      "case_created": "sample string 7",
      "current_status": "sample string 8",
      "with_guest_since": {},
      "previous_seconds_with_guest": 10,
      "sla_seconds": 11,
      "case_closed": {}
    }
  ],
  "yesterdays_closed_cases": [
    {
      "id": 1,
      "case_link": "sample string 2",
      "site_name": "sample string 3",
      "site_id": "sample string 4",
      "survey_type": "sample string 5",
      "source": "sample string 6",
      "topics": [
        {},
        {}
      ],
      "case_created": "sample string 7",
      "current_status": "sample string 8",
      "with_guest_since": "sample string 9",
      "previous_seconds_with_guest": 10,
      "sla_seconds": 11,
      "case_closed": "sample string 12"
    },
    {
      "id": 1,
      "case_link": "sample string 2",
      "site_name": "sample string 3",
      "site_id": "sample string 4",
      "survey_type": "sample string 5",
      "source": "sample string 6",
      "topics": [
        {},
        {}
      ],
      "case_created": "sample string 7",
      "current_status": "sample string 8",
      "with_guest_since": "sample string 9",
      "previous_seconds_with_guest": 10,
      "sla_seconds": 11,
      "case_closed": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<FeedItBackInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FeedItBackWebhook.Models">
  <clientId>1</clientId>
  <feedback>
    <Feedback>
      <blended_score>1</blended_score>
      <comments>sample string 9</comments>
      <consent>
        <consent_date>sample string 2</consent_date>
        <consent_terms_version>sample string 3</consent_terms_version>
        <marketing_consent>true</marketing_consent>
      </consent>
      <contact_requested>true</contact_requested>
      <csat_score>1</csat_score>
      <date_feedback_added>sample string 8</date_feedback_added>
      <date_of_visit>sample string 7</date_of_visit>
      <guest_demographics>
        <age_range>sample string 2</age_range>
        <gender>sample string 1</gender>
        <visit_frequency>sample string 4</visit_frequency>
        <visit_purpose>sample string 3</visit_purpose>
      </guest_demographics>
      <guest_details>
        <date_of_birth>sample string 5</date_of_birth>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <full_address>sample string 6</full_address>
        <last_name>sample string 4</last_name>
        <mobile_phone>sample string 8</mobile_phone>
        <postcode>sample string 7</postcode>
        <title>sample string 2</title>
      </guest_details>
      <incentive_voucher_sent>sample string 11</incentive_voucher_sent>
      <nps_score>1</nps_score>
      <platform>sample string 3</platform>
      <purchase>
        <check_number>sample string 1</check_number>
        <covers>3</covers>
        <line_items>
          <Line_Items>
            <family_group>sample string 3</family_group>
            <id>sample string 1</id>
            <major_group>sample string 4</major_group>
            <name>sample string 2</name>
            <price>5.1</price>
            <quantity>6</quantity>
          </Line_Items>
          <Line_Items>
            <family_group>sample string 3</family_group>
            <id>sample string 1</id>
            <major_group>sample string 4</major_group>
            <name>sample string 2</name>
            <price>5.1</price>
            <quantity>6</quantity>
          </Line_Items>
        </line_items>
        <table_number>sample string 2</table_number>
        <total_spend>4.1</total_spend>
      </purchase>
      <questions>
        <Question>
          <answer>sample string 3</answer>
          <id>1</id>
          <question>sample string 2</question>
        </Question>
        <Question>
          <answer>sample string 3</answer>
          <id>1</id>
          <question>sample string 2</question>
        </Question>
      </questions>
      <ratings>
        <Rating>
          <rating>sample string 1</rating>
          <score>2</score>
        </Rating>
        <Rating>
          <rating>sample string 1</rating>
          <score>2</score>
        </Rating>
      </ratings>
      <review_max_score>1</review_max_score>
      <review_score>1</review_score>
      <scorecard_link>sample string 4</scorecard_link>
      <site_id>sample string 6</site_id>
      <site_name>sample string 5</site_name>
      <staff_mention>sample string 10</staff_mention>
      <survey_type>sample string 2</survey_type>
      <type>sample string 1</type>
    </Feedback>
    <Feedback>
      <blended_score>1</blended_score>
      <comments>sample string 9</comments>
      <consent>
        <consent_date>sample string 2</consent_date>
        <consent_terms_version>sample string 3</consent_terms_version>
        <marketing_consent>true</marketing_consent>
      </consent>
      <contact_requested>true</contact_requested>
      <csat_score>1</csat_score>
      <date_feedback_added>sample string 8</date_feedback_added>
      <date_of_visit>sample string 7</date_of_visit>
      <guest_demographics>
        <age_range>sample string 2</age_range>
        <gender>sample string 1</gender>
        <visit_frequency>sample string 4</visit_frequency>
        <visit_purpose>sample string 3</visit_purpose>
      </guest_demographics>
      <guest_details>
        <date_of_birth>sample string 5</date_of_birth>
        <email>sample string 1</email>
        <first_name>sample string 3</first_name>
        <full_address>sample string 6</full_address>
        <last_name>sample string 4</last_name>
        <mobile_phone>sample string 8</mobile_phone>
        <postcode>sample string 7</postcode>
        <title>sample string 2</title>
      </guest_details>
      <incentive_voucher_sent>sample string 11</incentive_voucher_sent>
      <nps_score>1</nps_score>
      <platform>sample string 3</platform>
      <purchase>
        <check_number>sample string 1</check_number>
        <covers>3</covers>
        <line_items>
          <Line_Items>
            <family_group>sample string 3</family_group>
            <id>sample string 1</id>
            <major_group>sample string 4</major_group>
            <name>sample string 2</name>
            <price>5.1</price>
            <quantity>6</quantity>
          </Line_Items>
          <Line_Items>
            <family_group>sample string 3</family_group>
            <id>sample string 1</id>
            <major_group>sample string 4</major_group>
            <name>sample string 2</name>
            <price>5.1</price>
            <quantity>6</quantity>
          </Line_Items>
        </line_items>
        <table_number>sample string 2</table_number>
        <total_spend>4.1</total_spend>
      </purchase>
      <questions>
        <Question>
          <answer>sample string 3</answer>
          <id>1</id>
          <question>sample string 2</question>
        </Question>
        <Question>
          <answer>sample string 3</answer>
          <id>1</id>
          <question>sample string 2</question>
        </Question>
      </questions>
      <ratings>
        <Rating>
          <rating>sample string 1</rating>
          <score>2</score>
        </Rating>
        <Rating>
          <rating>sample string 1</rating>
          <score>2</score>
        </Rating>
      </ratings>
      <review_max_score>1</review_max_score>
      <review_score>1</review_score>
      <scorecard_link>sample string 4</scorecard_link>
      <site_id>sample string 6</site_id>
      <site_name>sample string 5</site_name>
      <staff_mention>sample string 10</staff_mention>
      <survey_type>sample string 2</survey_type>
      <type>sample string 1</type>
    </Feedback>
  </feedback>
  <open_cases>
    <Open_Cases>
      <case_closed />
      <case_created>sample string 7</case_created>
      <case_link>sample string 2</case_link>
      <current_status>sample string 8</current_status>
      <id>1</id>
      <previous_seconds_with_guest>10</previous_seconds_with_guest>
      <site_id>sample string 4</site_id>
      <site_name>sample string 3</site_name>
      <sla_seconds>11</sla_seconds>
      <source>sample string 6</source>
      <survey_type>sample string 5</survey_type>
      <topics xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </topics>
      <with_guest_since />
    </Open_Cases>
    <Open_Cases>
      <case_closed />
      <case_created>sample string 7</case_created>
      <case_link>sample string 2</case_link>
      <current_status>sample string 8</current_status>
      <id>1</id>
      <previous_seconds_with_guest>10</previous_seconds_with_guest>
      <site_id>sample string 4</site_id>
      <site_name>sample string 3</site_name>
      <sla_seconds>11</sla_seconds>
      <source>sample string 6</source>
      <survey_type>sample string 5</survey_type>
      <topics xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </topics>
      <with_guest_since />
    </Open_Cases>
  </open_cases>
  <yesterdays_closed_cases>
    <Yesterdays_Closed_Cases>
      <case_closed>sample string 12</case_closed>
      <case_created>sample string 7</case_created>
      <case_link>sample string 2</case_link>
      <current_status>sample string 8</current_status>
      <id>1</id>
      <previous_seconds_with_guest>10</previous_seconds_with_guest>
      <site_id>sample string 4</site_id>
      <site_name>sample string 3</site_name>
      <sla_seconds>11</sla_seconds>
      <source>sample string 6</source>
      <survey_type>sample string 5</survey_type>
      <topics xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </topics>
      <with_guest_since>sample string 9</with_guest_since>
    </Yesterdays_Closed_Cases>
    <Yesterdays_Closed_Cases>
      <case_closed>sample string 12</case_closed>
      <case_created>sample string 7</case_created>
      <case_link>sample string 2</case_link>
      <current_status>sample string 8</current_status>
      <id>1</id>
      <previous_seconds_with_guest>10</previous_seconds_with_guest>
      <site_id>sample string 4</site_id>
      <site_name>sample string 3</site_name>
      <sla_seconds>11</sla_seconds>
      <source>sample string 6</source>
      <survey_type>sample string 5</survey_type>
      <topics xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </topics>
      <with_guest_since>sample string 9</with_guest_since>
    </Yesterdays_Closed_Cases>
  </yesterdays_closed_cases>
</FeedItBackInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Output

Name	Description	Type	Additional information
Response		boolean	None.
Error		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Error": "sample string 2"
}

application/xml, text/xml

Sample:

<Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FeedItBackWebhook.Models">
  <Error>sample string 2</Error>
  <Response>true</Response>
</Output>