Jump to

• Request
• Response

Delete Screen Look Ups

post

/config/sim/v1/setup/deletescreenlookups

Deletes SLU object(s)

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string(string)
  Detail that Identifies that who made the change

Body ()

Body for SLU delete request

Root Schema : SLUDeleteRequestBody

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• objectNum(required): integer
  Object number of the SLU

  Example: 1
• type(required): integer
  Slu Type Number assigned to the SLU | Slu Type | SLU Name | Allowed Hierarchy Level | Allowed objectNum | |------------|-------------------------------|-------------------------------|-------------------| | 1 | Discount SLU | Zone/Location | 1-64 | | 2 | Service Charges SLU | Zone/Location | 1-64 | | 3 | Tender Media SLU | Zone/Location | 1-64 | | 6 | Menu Items SLU | Enterprise/Zone/Location/RVC | 1-999999999 | | 7 | Menu Item Master Group SLU | Zone/Location | 1-32 |

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "type"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the SLU",
            "type":"integer",
            "example":1
        },
        "type":{
            "description":"Slu Type Number assigned to the SLU\n\n| Slu Type   | SLU Name                      | Allowed Hierarchy Level       | Allowed objectNum |\n|------------|-------------------------------|-------------------------------|-------------------|\n|       1    | Discount SLU                  | Zone/Location                 |  1-64             |\n|       2    | Service Charges SLU           | Zone/Location                 |  1-64             |\n|       3    | Tender Media SLU              | Zone/Location                 |  1-64             |\n|       6    | Menu Items SLU                | Enterprise/Zone/Location/RVC  |  1-999999999      |\n|       7    | Menu Item Master Group SLU    | Zone/Location                 |  1-32             |\n",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Confirmation of Deletion of record(s).

Body ()

Root Schema : schema

Type: object

Show Source

• msg(required): string
  Example: 1 record deleted

{
    "type":"object",
    "required":[
        "msg"
    ],
    "properties":{
        "msg":{
            "type":"string",
            "example":"1 record deleted"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top