Configuration and Content API Guide

Get Dining Tables

post

/config/sim/v2/setup/getDiningTables

Gets all the Dining Tables

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Dining Tables.

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Dining Table records.
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of records in the data set"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Number of records returned on this page."
        },
        "items":{
            "type":"array",
            "description":"Dining Table records.",
            "items":{
                "$ref":"#/definitions/DiningTable"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"The maximum number of records returned on a page"
        }
    }
}

Nested Schema : items

Type: array

Dining Table records.

Show Source

Array of: object DiningTable

Dining Table record

{
    "type":"array",
    "description":"Dining Table records.",
    "items":{
        "$ref":"#/definitions/DiningTable"
    }
}

Nested Schema : DiningTable

Type: object

Dining Table record

Show Source

diningTableClassObjNum: integer

Object Number of the Dining Table class.

Example: 243
hierUnitId: integer

Hier Unit Id of the RVC

Example: 7
name: object name

Name of Dining Table.
objectNum: integer

Object Number of the Dining Table.

Example: 1

{
    "description":"Dining Table record",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Hier Unit Id of the RVC",
            "type":"integer",
            "example":7
        },
        "objectNum":{
            "description":"Object Number of the Dining Table.",
            "type":"integer",
            "example":1
        },
        "name":{
            "type":"object",
            "description":"Name of Dining Table.",
            "example":{
                "1":"Entp",
                "2":"Untm",
                "3":"Emp"
            }
        },
        "diningTableClassObjNum":{
            "description":"Object Number of the Dining Table class.",
            "type":"integer",
            "example":243
        }
    }
}

Nested Schema : name

Type: object

Name of Dining Table.

Example:

{
    "1":"Entp",
    "2":"Untm",
    "3":"Emp"
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details