Jump to

• Request
• Response

Add Effectivity Groups

post

/config/sim/v1/setup/effectivitygroups

Add an Effectivity Groups record for the current organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

An Effectivity Group Object

Root Schema : EffectivityGroups

Type: object

Show Source

• activeTimes(optional): object activeTimes
• dataExtentions(optional): object dataExtentions
  An array of data extensions for the menu item
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• hierUnitName(optional): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum(optional): integer
  Hierarchy unit object number

  Example: 1
• name: object OrderDeviceTranslatedString
  name of the Order Device
• objectNum: integer
  Object number of the effectivity group

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Hierarchy unit object number",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "description":"Hierarchy unit name",
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "objectNum":{
            "description":"Object number of the effectivity group",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"name of the effectivity group",
            "$ref":"#/definitions/OrderDeviceTranslatedString"
        },
        "activeTimes":{
            "type":"object",
            "properties":{
                "effId":{
                    "description":"The unique reference of the effectivity record",
                    "type":"integer",
                    "example":1
                },
                "startTime":{
                    "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.",
                    "type":"string",
                    "example":"2020-01-01T00:00:00"
                },
                "endTime":{
                    "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive",
                    "type":"string",
                    "example":"2020-12-31T23:59:59"
                },
                "timeIsLocal":{
                    "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.",
                    "type":"boolean",
                    "example":false
                }
            }
        },
        "dataExtentions":{
            "description":"An array of data extensions for the menu item",
            "type":"object",
            "properties":{
                "columnName":{
                    "description":"Name of the extention field",
                    "type":"string",
                    "example":"extension_Column"
                },
                "value":{
                    "description":"value of the extension field",
                    "type":"string",
                    "example":"value1"
                }
            }
        }
    }
}

Nested Schema : activeTimes

Type: object

Show Source

• effId(optional): integer
  The unique reference of the effectivity record

  Example: 1
• endTime(optional): string
  The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive

  Example: 2020-12-31T23:59:59
• startTime(optional): string
  The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.

  Example: 2020-01-01T00:00:00
• timeIsLocal(optional): boolean
  A Boolean flag indicating if the Start/End times represent the local time of the property.

  Example: false

{
    "type":"object",
    "properties":{
        "effId":{
            "description":"The unique reference of the effectivity record",
            "type":"integer",
            "example":1
        },
        "startTime":{
            "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.",
            "type":"string",
            "example":"2020-01-01T00:00:00"
        },
        "endTime":{
            "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive",
            "type":"string",
            "example":"2020-12-31T23:59:59"
        },
        "timeIsLocal":{
            "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : dataExtentions

Type: object

An array of data extensions for the menu item

Show Source

• columnName(optional): string
  Name of the extention field

  Example: extension_Column
• value(optional): string
  value of the extension field

  Example: value1

{
    "description":"An array of data extensions for the menu item",
    "type":"object",
    "properties":{
        "columnName":{
            "description":"Name of the extention field",
            "type":"string",
            "example":"extension_Column"
        },
        "value":{
            "description":"value of the extension field",
            "type":"string",
            "example":"value1"
        }
    }
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "ar-AR":"??????????"
}

Nested Schema : OrderDeviceTranslatedString

Type: object

name of the Order Device

Example:

{
    "en-US":"Order Device 1",
    "es-SS":"Order Device"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response indicating the EffGrp object added.

Body ()

Root Schema : EffGroupDeleteRequestBody

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the printer

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the printer",
            "type":"integer",
            "example":1
        }
    }
}

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

Back to Top