GET api/HeaderAnalysis

Retrieve the Header Analysis

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Company	The company code	string	Required String length: inclusive between 0 and 6
Head	The header analysis head: H1-H5	string	String length: inclusive between 0 and 2
PageSize	Optional paging parameter. Return x records per page	integer	None.
PageNumber	Optional paging parameter. Number of page to return	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Company": "EPM",
  "Head": "H1",
  "PageSize": 0,
  "PageNumber": 0
}

Response Information

Resource Description

HeaderAnalysisRes

Name	Description	Type	Additional information
msgControl	Message control - Will contain information about the response	MsgControl	None.
HeaderAnalysisList	List of header analysis	Collection of HeaderAnalysis	None.

Response Formats

application/json, text/json

Sample:

{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/<Request Name>",
    "AppName": "EsoftWebApi",
    "EsoftUser": "Web API",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2019-12-25T00:00:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "HeaderAnalysisList": [
    {
      "Head": "H1",
      "Code": "NIC",
      "Description": "NICOSIA"
    },
    {
      "Head": "H1",
      "Code": "LIM",
      "Description": "LIMASSOL"
    }
  ]
}