Jump to

• Request
• Response

Retrieves the Sweep Products by ID

get

/service/lmc/sweepproducts/{id}

This endpoint is used to retrieve the sweep products by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  Id of the user that needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the sweepproducts based on given id.

Body ()

Root Schema : LmmTmSweepProductsWrapperServiceDTO

Type: object

Show Source

• data: object LmmTmSweepProductsDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/LmmTmSweepProductsDTO"
        }
    }
}

Nested Schema : LmmTmSweepProductsDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmSweepProductsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "productCode":{
                    "type":"string",
                    "description":""
                },
                "productDescription":{
                    "type":"string",
                    "description":""
                },
                "LmmTmSweepProductDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmSweepProductDetailsDTO"
                    }
                }
            },
            "required":[
                "id",
                "productCode"
            ]
        }
    ]
}

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

Type: object

Show Source

• LmmTmSweepProductDetailsDTO: array LmmTmSweepProductDetailsDTO
• productCode(required): string
• productDescription: string

{
    "type":"object",
    "properties":{
        "productCode":{
            "type":"string",
            "description":""
        },
        "productDescription":{
            "type":"string",
            "description":""
        },
        "LmmTmSweepProductDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmSweepProductDetailsDTO"
            }
        }
    },
    "required":[
        "id",
        "productCode"
    ]
}

Nested Schema : LmmTmSweepProductDetailsDTO

Type: array

Show Source

• Array of: object LmmTmSweepProductDetailsDTO

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

Nested Schema : LmmTmSweepProductDetailsDTO

Type: object

Show Source

• id: string
• mandatory: string
• parameterName: string
• parameterType: string
• sweepProductId(required): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "sweepProductId":{
            "type":"string",
            "description":""
        },
        "parameterName":{
            "type":"string",
            "description":""
        },
        "parameterType":{
            "type":"string",
            "description":""
        },
        "mandatory":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "sweepProductId"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top