Jump to

• Request
• Response

To get Unauthorized Records

get

/service/lmx/preEODCheck/{branchCodeId}

This endpoint is used to get unauthorized maintenance,structure and sweep pending records.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• branchCodeId(required): string
  branchCodeId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created fileupload

Body ()

Root Schema : LmxTbPreEODCheckResponseCollection

Type: object

Collection of unauthorised structures, pending sweeps.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of unauthorised structures, pending sweeps.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTbPreEODCheckResponseDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmxTbPreEODCheckResponseDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : LmxTbPreEODCheckResponseDTO

Type: object

Show Source

• adhoc: array adhoc
• cmcMaintenance: array cmcMaintenance
• oblmMaintenance: array oblmMaintenance
• smsMaintenance: array smsMaintenance
• structure: array structure
• sweep: array sweep

{
    "type":"object",
    "properties":{
        "cmcMaintenance":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MaintenanceRecordDTO"
            }
        },
        "smsMaintenance":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MaintenanceRecordDTO"
            }
        },
        "oblmMaintenance":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MaintenanceRecordDTO"
            }
        },
        "structure":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTbStructureDTO"
            }
        },
        "sweep":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmbSweepListDTO"
            }
        },
        "adhoc":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmbAdhocSweepListDTO"
            }
        }
    }
}

Nested Schema : adhoc

Type: array

Show Source

• Array of: object LmbAdhocSweepListDTO

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

Nested Schema : cmcMaintenance

Type: array

Show Source

• Array of: object MaintenanceRecordDTO

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

Nested Schema : oblmMaintenance

Type: array

Show Source

• Array of: object MaintenanceRecordDTO

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

Nested Schema : smsMaintenance

Type: array

Show Source

• Array of: object MaintenanceRecordDTO

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

Nested Schema : structure

Type: array

Show Source

• Array of: object LmxTbStructureDTO

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

Nested Schema : sweep

Type: array

Show Source

• Array of: object LmbSweepListDTO

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

Nested Schema : LmbAdhocSweepListDTO

Type: object

Show Source

• executionType: string
• status: string
• structureDesc: string
• structureId: string
  Pattern: [A-Z0-9]{1,30}

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "executionType":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : MaintenanceRecordDTO

Type: object

Show Source

• data: string
• maintenance: string

{
    "type":"object",
    "properties":{
        "maintenance":{
            "type":"string",
            "description":""
        },
        "data":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : LmxTbStructureDTO

Type: object

Show Source

• structureDesc: string
• structureId: string
  Pattern: [A-Z0-9]{1,30}

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : LmbSweepListDTO

Type: object

Show Source

• status: string
• structureDesc: string
• structureId: string
  Pattern: [A-Z0-9]{1,30}

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        }
    }
}

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