Method :POST

URL: https://apiv1.publicators.com/api/Forms/GetFormByName

Get active Forms by name. its possible that there are more than one form with the same name.

Request Information

URI Parameters

None.

Body Parameters

Json format: FormByNameBindingModel

FormByNameBindingModel
NameDescriptionTypeAdditional information
form_name

Form name

string

Required

Auth

Authorization token

AuthorizationTokenBindingModel

Required

Request Formats

application/json, text/json

Sample:
{
  "form_name": "sample string 1",
  "Auth": {
    "Token": "7a9fb26b-d97c-46a6-af3c-6da5fb344227"
  }
}

Response Information

Resource Description

Json format: IEnumerable of FormViewModel

Collection of FormViewModel
NameDescriptionTypeAdditional information
form_id

Form Id

integer

None.

form_name

Form name

string

None.

form_notify_toemail

Email to be notified for each newly registered

string

None.

list_id

List Id to store the newly registered

integer

None.

form_optin

Recipient inserted as approval status

boolean

None.

form_created

Form Date Created DateTime format yyyy/MM/dd HH:mm:ss

date

None.

form_lang

Form language

FormLangType

None.

FormLink

Return custom link

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "form_id": 1,
    "form_name": "sample string 2",
    "form_notify_toemail": "sample string 3",
    "list_id": 4,
    "form_optin": true,
    "form_created": "2018/04/25 09:31:19",
    "form_lang": 0,
    "FormLink": "sample string 7"
  },
  {
    "form_id": 1,
    "form_name": "sample string 2",
    "form_notify_toemail": "sample string 3",
    "list_id": 4,
    "form_optin": true,
    "form_created": "2018/04/25 09:31:19",
    "form_lang": 0,
    "FormLink": "sample string 7"
  }
]