Jump to

• Request
• Response

Get Family Groups

post

/config/sim/v1/menuItems/getFamilyGroups

Gets a list of Family Groups

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : FamilyGroupGetRequestBody

Type: object

Show Source

• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.

  Example: comboMealGroups.objectNum
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"comboMealGroups.objectNum",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of family group entities in an organization.

Body ()

Root Schema : FamilyGroup

Type: object

Model for Family Group Object

Show Source

• consumerDesc(optional): object TranslatedString_Name
  A group of string objects representing the name of the tax in configured languages
• consumerName(optional): object TranslatedString_Name
  A group of string objects representing the name of the tax in configured languages
• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• images(optional): array images
  An array of images associated with the menu item
• majorGrpName(optional): object TranslatedString_MajorGrpName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the major group in configured languages
• majorGrpObjNum(optional): integer
  Object number of the major group

  Example: 2
• name: object TranslatedString_Name
  A group of string objects representing the name of the tax in configured languages
• objectNum: integer
  Object Number of the family group

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the family group"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "consumerDesc":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "consumerName":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "majorGrpObjNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the major group"
        },
        "majorGrpName":{
            "$ref":"#/definitions/TranslatedString_MajorGrpName"
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_image"
            }
        }
    },
    "description":"Model for Family Group Object"
}

Nested Schema : TranslatedString_Name

Type: object

A group of string objects representing the name of the tax in configured languages

Example:

{
    "en-US":"Family Group 1",
    "es-SS":"Grupo familiar 1",
    "lt=LT":"1 ??eimos grup??"
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : images

Type: array

An array of images associated with the menu item

Show Source

• Array of: object MenuItem_image

{
    "type":"array",
    "description":"An array of images associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_image"
    }
}

Nested Schema : TranslatedString_MajorGrpName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the major group in configured languages",
    "example":{
        "en-US":"Major Group 1",
        "es-SS":"Grupo principal 1",
        "lt=LT":"1 pagrindin?? grup??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the major group in configured languages

Example:

{
    "en-US":"Major Group 1",
    "es-SS":"Grupo principal 1",
    "lt=LT":"1 pagrindin?? grup??"
}

Nested Schema : MenuItem_image

Type: object

Show Source

• altText(optional): string
  The image alternative text of the menu item

  Example: pizza
• description(optional): string
  The description text of the menu item

  Example: pizza description
• imageIndex(optional): integer
  Image Number for reference

  Example: 1
• isCloudImage(optional): boolean
  Flag indicating if the image is stored on the Cloud

  Example: true
• size(optional): string
  The size of the image

  Example: 1
• url(optional): string
  The URL of the image of the menu item

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "type":"object",
    "properties":{
        "imageIndex":{
            "type":"integer",
            "example":1,
            "description":"Image Number for reference"
        },
        "url":{
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg",
            "description":"The URL of the image of the menu item"
        },
        "altText":{
            "type":"string",
            "example":"pizza",
            "description":"The image alternative text of the menu item"
        },
        "description":{
            "type":"string",
            "example":"pizza description",
            "description":"The description text of the menu item"
        },
        "isCloudImage":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if the image is stored on the Cloud"
        },
        "size":{
            "type":"string",
            "example":"1",
            "description":"The size of the image"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

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

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top