Jump to

• Request
• Response

Get all valid sweepmaster data.

get

/api/1.0/service/lms/sweepmaster

This endpoint is used to get all valid sweep master maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• includecloseandunauth: boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit: integer
  limit is maximum no of records to be fetched
• offset: integer
  offset is starting no of records to be fetched

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmsTbSweepMasterServiceCollection

Type: object

Collection of sweepmaster data.

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmsTbSweepMasterDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : LmsTbSweepMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmsTbSweepMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "executionId":{
                    "type":"string",
                    "description":"",
                    "maxLength":"30"
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9a-fA-Z-]{1,36}"
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "executionTime":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "status":{
                    "type":"string",
                    "description":""
                },
                "statusMessage":{
                    "type":"string",
                    "description":"",
                    "maxLength":"100"
                },
                "valueDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "errorReference":{
                    "type":"string",
                    "description":"",
                    "maxLength":"36"
                },
                "isBvt":{
                    "type":"string",
                    "description":"",
                    "maxLength":"1"
                },
                "bvtId":{
                    "type":"string",
                    "description":"",
                    "maxLength":"36"
                },
                "isSimulate":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

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 : LmsTbSweepMasterDTO-allOf[1]

Type: object

Show Source

• bvtId: string
  Maximum Length: 36
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• errorReference: string
  Maximum Length: 36
• executionId: string
  Maximum Length: 30
• executionTime: string(date)
• isBvt: string
  Maximum Length: 1
• isSimulate: string
• status: string
• statusMessage: string
  Maximum Length: 100
• structureId: string
  Pattern: [0-9a-fA-Z-]{1,36}
• valueDate: string(date)

{
    "type":"object",
    "properties":{
        "executionId":{
            "type":"string",
            "description":"",
            "maxLength":"30"
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "executionTime":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "statusMessage":{
            "type":"string",
            "description":"",
            "maxLength":"100"
        },
        "valueDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "errorReference":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "isBvt":{
            "type":"string",
            "description":"",
            "maxLength":"1"
        },
        "bvtId":{
            "type":"string",
            "description":"",
            "maxLength":"36"
        },
        "isSimulate":{
            "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