Configuration and Content API Guide

Get Enterprise Levels

post

/config/sim/v1/hierarchy/locations/getEnterpriseLevels

Gets available enterprise levels of the organization.

Request

Supported Media Types

application/json
multipart/form-data

Request body for get enterprise levels.

Root Schema : GetEnterpriseLevelsRequest

Type: object

The input body model that needs to be given for get request.

Show Source

include: string

Objects included in response

Example: name
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
limit: integer

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

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

{
    "description":"The input body model that needs to be given for get request.",
    "type":"object",
    "properties":{
        "include":{
            "type":"string",
            "description":"Objects included in response",
            "example":"name"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A list of available enterprise levels present in the organization.

Root Schema : GetEnterpriseLevelsResponse

Type: object

Show Source

count: integer

Current response record count.

Example: 1
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: false
items: array items

Array of Enterprise Levels.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 1

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":"1",
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":"1",
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Enterprise Levels.",
            "items":{
                "$ref":"#/definitions/EnterpriseLevels"
            }
        },
        "offset":{
            "type":"integer",
            "example":"0",
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":"10",
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Enterprise Levels.

Show Source

Array of: object EnterpriseLevels

{
    "type":"array",
    "description":"Array of Enterprise Levels.",
    "items":{
        "$ref":"#/definitions/EnterpriseLevels"
    }
}

Nested Schema : EnterpriseLevels

Type: object

Show Source

name(required): array name

Name of enterprise level

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Name of enterprise level",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":"District"
        }
    }
}

Nested Schema : name

Type: array

Name of enterprise level

Show Source

Array of: string

{
    "description":"Name of enterprise level",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":"District"
}

Example:

District

400 Response

400 Bad Request

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"
        }
    }
}