Previous Next JavaScript must be enabled to correctly display this content

## Get all valid ECA systems

get

/service/ecasystems

This endpoints will be used to Get all valid eca systems maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
- checkerId(optional): string
- ecaSystem(optional): string
- ecaSystemDescription(optional): string
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- limit(optional): integer
  limit is maximum no of records to be fetched
- makerId(optional): string
- offset(optional): integer
  offset is starting no of records to be fetched
- recordStat(optional): string
- sourceCode(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string

Body ()
Root Schema : ECASystemServiceCollection
Type: `object`
Collection of ecasystem.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of ecasystem.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ECASystemServiceDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object ECASystemServiceDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/ECASystemServiceDTO"
        }
    }

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

Nested Schema : ECASystemServiceDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object ECASystemServiceDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "ecaSystem":{
                        "type":"string",
                        "description":"Name of the ECA system",
                        "minLength":1,
                        "maxLength":15,
                        "pattern":"[a-zA-Z0-9\\s]+"
                    },
                    "ecaSystemDescription":{
                        "type":"string",
                        "description":"Description for ECA system",
                        "minLength":0,
                        "maxLength":105
                    }
                },
                "required":[
                    "ecaSystem"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : ECASystemServiceDTO-allOf[1]
Type: `object`
Show Source

- ecaSystem: string
  Minimum Length: `1`
  Maximum Length: `15`
  Pattern: `[a-zA-Z0-9\s]+`
  Name of the ECA system
- ecaSystemDescription(optional): string
  Minimum Length: `0`
  Maximum Length: `105`
  Description for ECA system

    {
        "type":"object",
        "properties":{
            "ecaSystem":{
                "type":"string",
                "description":"Name of the ECA system",
                "minLength":1,
                "maxLength":15,
                "pattern":"[a-zA-Z0-9\\s]+"
            },
            "ecaSystemDescription":{
                "type":"string",
                "description":"Description for ECA system",
                "minLength":0,
                "maxLength":105
            }
        },
        "required":[
            "ecaSystem"
        ]
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top