POST Screen

POST Screen

The POST Screen Form API allows you to create a form programmatically rather than in the designer.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/screen/form?format=xml/json

You may use either JSON or XML formats in your POST request.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.

If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element: xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
USapi/v2/screen/formModel Description/Schema & Parameters

Parameters

The POST verb allows you to create a form programmatically rather than in the designer. The required and optional parameters for a POST call to the Screen API are outlined below.

NameTypeDescriptionRequired
CompanyIdIntegerYour unique Company Id found on the Organisation Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key found on the Organisation Setup page of the secure website.✓
Name
StringThe Form’s title used for all default display to app users.✓
Description
String
The Form’s description. 
Design
Array[FormScreenControl]
The full design for this Form. 
Settings
ArrayThe settings for this Form.
 
Connectors
ArrayThe connectors for this Form. 

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform. 

Due to the sheer size and the vast number of possible parameters that can be used in constructing a POST JSON body, we’ve used a shortened sample of what a JSON Body looks like when making a POST submission to the Appenate API. Full details of the API and parameters can be found here, 

ControlType Options

The ControlType property allows you to specify which field type you want to use in your JSON Body, below is a list of all possible ControlTypes.

Structure and Layout: Page, Section, Flowlayout, EndFlowLayout, Table, EndTable, Gallery, EndGallery
Data Entry: Text, Numeric, Date, Choices, Hidden
Media/Advanced: Media, Gallerymedia, Signature, Sketch, Barcode, QR, NFC, Ocr, Location, File
Action/Integration: Action, Autonumber, Datasource, Step, Rest

Request URL

https://eforms.mobileform.net/api/v2/screen/form

Request Body

{
  "Name": "Job Safety Analysis1",
  "ExternalId": "JobSafetyAnalysis1",
  "Icon": "Science",
  "IsLatestVersion": true,
  "Description": "MadeWithScreenAPI",
  "ChangeStatusTo": "Published",
  "FormScreen": {
    "Connectors": [],
    "Settings": {
      "PageNamesTab": {
        "BackgroundColor": "#BBBBBB",
        "SelectedBackgroundColor": "#0072C6",
        "Style": {
          "color": "#FFFFFF",
          "decor": "Normal",
          "size": "Medium"
        },
        "LimitToCurrentStep": true
      },
      "TitleBarButtons": {
        "Button1": {
          "Title": "Exit",
          "Style": {
            "color": "#3F3F3F",
            "decor": "Bold",
            "size": "Medium"
          },
          "Interaction": {
            "Type": "ExitAllScreens",
            "Screen": "",
            "Value": ""
          },
          "BackgroundColor": "transparent",
          "Icon": "",
          "Visibility": ""
        },
        "Button2": {
          "Title": "",
          "Style": {
            "color": "#FFFFFF",
            "decor": "Bold",
            "size": "Medium"
          },
          "Interaction": {
            "Type": "ForceSync",
            "Screen": "",
            "Value": ""
          },
          "BackgroundColor": "transparent",
          "Icon": "Sync",
          "Visibility": ""
        },
        "Button3": {
          "Title": "",
          "Style": {
            "color": "#FFFFFF",
            "decor": "Bold",
            "size": "Medium"
          },
          "Interaction": {
            "Type": "JumpPage",
            "Screen": ":prev:",
            "Value": ""
          },
          "BackgroundColor": "transparent",
          "Icon": "ArrowLeft",
          "Visibility": ""
        },
        "Button4": {
          "Title": "",
          "Style": {
            "color": "#FFFFFF",
            "decor": "Bold",
            "size": "Medium"
          },
          "Interaction": {
            "Type": "JumpPage",
            "Screen": ":next:",
            "Value": ""
          },
          "BackgroundColor": "transparent",
          "Icon": "ArrowRight",
          "Visibility": ""
        }
      },
      "EnablePageSwiping": false,
      "ImageResizeTo": "800",
      "LogUserLocation": true,
      "HistoryDays": 14,
      "HideSplash": true,
      "DisplayOrder": 1,
      "HtmlTemplateText": "",
      "OutputTemplate": "ClassicGray"
    }
  },
    "Design": [
      {
        "Title": "Sample Field Text",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "HintStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "ControlType": "Page",
        "DataName": "page1",
        "Visibility": "",
        "BackgroundColor": "#DDDDDD",
        "ValidationMode": "Inline",
        "Comment": ""
      },
{
        "Title": "Section 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Section",
        "DataName": "section1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "Comment": ""
      },
      {
        "Title": "Text 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Text",
        "DataName": "text1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "NumberLines": "1",
        "AnswerFormat": "",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
{
        "Title": "Number 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Numeric",
        "DataName": "number1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "Title": "Date 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Date",
        "DataName": "date1",
        "DynamicValue": "",
        "Visibility": "",
        "Kind": "Date & Time",
        "BackgroundColor": "#EEEEEE",
        "DisplayKind": "Hours12",
        "MinuteInterval": "1",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "StaticOptions": [
          {
            "Text": "1",
            "Value": "1"
          }
        ],
        "Title": "Choices 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Choices",
        "DataName": "choices1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "DisplayStyle": "Drop Down List",
        "OptionBg": "#EEEEEE",
        "CollapseOptions": true,
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "Title": "Location 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Location",
        "DataName": "location1",
        "DynamicValue": "",
        "Visibility": "",
        "Kind": "Standard",
        "BackgroundColor": "#EEEEEE",
        "Accuracy": "10",
        "OverlayGeo": "",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "FastAcquisition": true,
        "Comment": ""
      },
 {
        "Title": "Media 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "WatermarkOptions": {
          "Alignment": "TopRight",
          "Style": {
            "color": "#ffffff",
            "decor": "Bold",
            "size": "Large"
          },
          "BackgroundColor": "transparent"
        },
        "ControlType": "Media",
        "DataName": "media1",
        "DynamicValue": "",
        "Visibility": "",
        "Kind": "Image",
        "BackgroundColor": "#EEEEEE",
        "CaptureFromUrl": "",
        "DisplayKind": "Standard",
        "BindToGlobal": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": "",
        "FileName": ""
      },
      {
        "Title": "Signature 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "WatermarkOptions": {
          "Alignment": "TopRight",
          "Style": {
            "color": "#ffffff",
            "decor": "Bold",
            "size": "Large"
          },
          "BackgroundColor": "transparent"
        },
        "Buttons": {
          "Button1": {
            "Title": "Show QR",
            "Style": {
              "color": "#FFFFFF",
              "decor": "Bold",
              "size": "Large"
            },
            "BackgroundColor": "#0072C6"
          },
          "Button2": {
            "Title": "Get Sign",
            "Style": {
              "color": "#FFFFFF",
              "decor": "Bold",
              "size": "Large"
            },
            "BackgroundColor": "#0072C6"
          },
          "Button3": {
            "Title": "Sign Screen",
            "Style": {
              "color": "#FFFFFF",
              "decor": "Bold",
              "size": "Large"
            },
            "BackgroundColor": "#0072C6"
          }
        },
        "ControlType": "Signature",
        "DataName": "signature1",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "SignatureColor": "#333333",
        "BindToGlobal": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": "",
        "FileName": ""
      },
{
        "Title": "Auto Number 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "AutoNumberOptions": {
          "SequenceStart": "1",
          "SequencePadding": "5",
          "DisplayValue": "(Auto-Number)",
          "GenerateMessage": "Generating Auto-Number..."
        },
        "ControlType": "Autonumber",
        "DataName": "autoNumber1",
        "DynamicValue": "!NUM!",
        "Kind": "Entry",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "ShowInteractionResult": true,
        "Comment": ""
      },
      {
        "Title": "Barcode 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Barcode",
        "DataName": "barcode1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "BarcodeFormats": "",
        "BarcodeMinimumLength": "6",
        "ScannerType": "DeviceCamera",
        "Comment": ""
      },
      {
        "Title": "OCR 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Ocr",
        "DataName": "ocr1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "ResultMode": "RawText",
        "Comment": ""
      },
      {
        "Title": "QR Code 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "QR",
        "DataName": "qrCode1",
        "DynamicValue": "1",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "Comment": "",
        "QrForeground": "#333333",
        "QrBackground": "#FFFFFF"
      },

{
        "Title": "Sketch 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "WatermarkOptions": {
          "Alignment": "TopRight",
          "Style": {
            "color": "#ffffff",
            "decor": "Bold",
            "size": "Large"
          },
          "BackgroundColor": "transparent"
        },
        "ControlType": "Sketch",
        "DataName": "sketch1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": "",
        "FileName": ""
      },
      {
        "Title": "Hidden 1",
        "TitleStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "HintStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "ControlType": "Hidden",
        "DataName": "hidden1",
        "DynamicValue": "",
        "BindToGlobal": "",
        "DefaultValue": "",
        "Comment": ""
      },
      {
        "Title": "Action 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Buttons": {
          "Button1": {
            "Title": ""
          },
          "Button2": {
            "Title": ""
          },
          "Button3": {
            "Title": "Tap Here",
            "Style": {
              "color": "#FFFFFF",
              "decor": "Bold",
              "size": "Large"
            },
            "BackgroundColor": "#0072C6"
          },
          "Button4": {
            "Title": ""
          },
          "Button5": {
            "Title": ""
          }
        },
        "ControlType": "Action",
        "DataName": "action1",
        "Visibility": "",
        "BackgroundColor": "#DDDDDD",
        "BindToGlobal": "",
        "InvalidText": "",
        "InteractionResult": "",
        "ExcludeFromDataPage": true,
        "Comment": ""
      },
      {
        "Title": "Table 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Button": {
          "Title": "",
          "Style": {
            "color": "#000000",
            "decor": "Bold",
            "size": "Medium"
          },
          "BackgroundColor": "transparent"
        },
        "ControlType": "Table",
        "DataName": "table1",
        "Visibility": "",
        "BackgroundColor": "#DDDDDD",
        "Repeatable": true,
        "ValidationMode": "Inline",
        "DataSourceRowLimit": "100",
        "Comment": "",
        "ShowSearchBar": true
      },
      {
        "Title": "Text in table 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Text",
        "DataName": "textInTable1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "NumberLines": "1",
        "AnswerFormat": "",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "ControlType": "EndTable"
      },

{
        "TitleStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "HintStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "ControlType": "Flowlayout",
        "DataName": "layout1",
        "Comment": "",
        "ResponsiveBreakpoint": "700",
        "MobileColumns": "2",
        "TabletColumns": "3"
      },
      {
        "Title": "Text in Flow 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Text",
        "DataName": "textInFlow1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "NumberLines": "1",
        "AnswerFormat": "",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "Title": "Number in Flow 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Placeholder": "",
        "ControlType": "Numeric",
        "DataName": "numberInFlow1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      },
      {
        "ControlType": "EndFlowLayout"
      },
      {
        "Title": "Gallery 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "Gallery",
        "DataName": "gallery1",
        "Visibility": "",
        "BackgroundColor": "#DDDDDD",
        "Repeatable": true,
        "ValidationMode": "Inline",
        "DataSourceRowLimit": "30",
        "Comment": ""
      },
      {
        "Title": "",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "WatermarkOptions": {
          "Alignment": "TopRight",
          "Style": {
            "color": "#ffffff",
            "decor": "Bold",
            "size": "Large"
          },
          "BackgroundColor": "transparent"
        },
        "ControlType": "Gallerymedia",
        "DataName": "gallery1_media",
        "BackgroundColor": "#EEEEEE",
        "DisplayKind": "Standard",
        "Comment": "",
        "FileName": ""
      },
      {
        "ControlType": "EndGallery"
      },

{
        "Title": "Attach 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "ControlType": "File",
        "DataName": "attach1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "CaptureFromUrl": "",
        "BindToGlobal": "",
        "InvalidText": "",
        "CustomValidation": "",
        "LimitFileTypes": "",
        "Comment": "",
        "FileName": ""
      },
      {
        "DataSource": {
          "Name": "AccredoDS"
        },
        "Title": "Data 1",
        "TitleStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "HintStyle": {
          "decor": "Normal",
          "size": "Medium"
        },
        "ControlType": "Datasource",
        "DataName": "data1",
        "DynamicValue": "",
        "DefaultValue": "",
        "Comment": ""
      },

{
        "Title": "Process 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "Buttons": {
          "Button2": {
            "Title": "Submit",
            "Style": {
              "color": "#FFFFFF",
              "decor": "Bold",
              "size": "Large"
            },
            "Interaction": {
              "Type": "UploadForm",
              "Screen": "",
              "Value": ""
            },
            "BackgroundColor": "#0072C6",
            "States": {
              "Selected": {
                "BackgroundColor": "#0072C6"
              },
              "Unselected": {
                "BackgroundColor": "#BBBBBB"
              }
            }
          }
        },
        "ControlType": "Step",
        "DataName": "process1",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "Comment": ""
      },
      {
        "Title": "NFC 1",
        "TitleStyle": {
          "color": "#333333",
          "decor": "Normal",
          "size": "Medium"
        },
        "Hint": "",
        "HintStyle": {
          "color": "#7B7B7B",
          "decor": "Italic",
          "size": "Medium"
        },
        "NfcOptions": {
          "MimeType": "",
          "RecordKey": "All",
          "FormulaValue": ""
        },
        "ControlType": "NFC",
        "DataName": "nfc1",
        "DynamicValue": "",
        "Visibility": "",
        "BackgroundColor": "#EEEEEE",
        "BindToGlobal": "",
        "DefaultValue": "",
        "InvalidText": "",
        "CustomValidation": "",
        "Comment": ""
      }

 
  ],
  "DesignFormat": "FullDesign",
  "IntegrationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "CompanyId": 12345
}

    • Related Articles

    • POST Folder

      The POST Folder API creates a new folder in the company’s account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either ...

    • POST Repository API (Create)

      The POST Repository API registers new content from a company account into the Repository. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response ...

    • POST Repository API (Create Installations)

      Using this API endpoint and the POST verb, you can install/update repository item content in a target company account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter ...

    • POST Usergroup

      This API allows you to create a new user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

    • POST Company

      This request method lets you create a new company account through the API, specifying the company details as parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter ...