POST v1/admin/survey/send

Request Information

URI Parameters

None.

Body Parameters

AdminSendSurveyRequestModel
NameDescriptionTypeAdditional information
user_uid_list

Collection of string

None.

survey_id

integer

None.

useFilteredUser

boolean

None.

filter_user_id

integer

None.

filter_user_cell_number

string

None.

filter_user_citizenship_number

string

None.

filter_user_first_name

string

None.

filter_company_uid

string

None.

filter_user_vehicle_is_company_vehicle

boolean

None.

user_company_id

Company UID of the active user

string

Required

Data type: Text

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text

Request Format

application/json, text/json

Sample:
{
  "user_uid_list": [
    "sample string 1",
    "sample string 2"
  ],
  "survey_id": 1,
  "useFilteredUser": true,
  "filter_user_id": 3,
  "filter_user_cell_number": "sample string 4",
  "filter_user_citizenship_number": "sample string 5",
  "filter_user_first_name": "sample string 6",
  "filter_company_uid": "sample string 7",
  "filter_user_vehicle_is_company_vehicle": true,
  "user_company_id": "sample string 8",
  "user_id": "sample string 9",
  "user_signature": "sample string 10"
}

Response Information

Resource Description

BaseMetaResultModel
NameDescriptionTypeAdditional information
meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}