Jump to

• Request
• Response

Get Employee Roles

post

/config/sim/v1/employees/getRoles

Gets a list of all the roles associated with the given employee in the specified organization

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : EmployeeRoleBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
• languages(optional): string
• limit(optional): integer
• objectNum: integer
• offset(optional): integer
• orderBy(optional): string
• searchCriteria(optional): string

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string"
        },
        "include":{
            "type":"string"
        },
        "languages":{
            "type":"string"
        },
        "offset":{
            "type":"integer"
        },
        "limit":{
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "objectNum":{
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of associated roles of a particular employee in an organization.

Body ()

Root Schema : EmployeeRole

Type: object

Model for an Employee Role Object

Show Source

• hierObjNum(optional): integer
  Object number of the hierarchy unit where the employee role is configured

  Example: 26
• hierUnitId: integer
  Unique reference of the hierarchy unit where the employee role is configured

  Example: 3599
• hierUnitName(optional): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• objectNum: integer
  Unique reference of the employee in the system.

  Example: 1
• roleEmployeeId: integer
  Unique reference of Employee

  Example: 1
• roleName(optional): object RoleNameTranslatedString
  A string that contains translations of employee role name into multiple languages
• roleObjNum: integer
  The object number of the employee role

  Example: 1000

{
    "description":"Model for an Employee Role Object",
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "roleObjNum",
        "roleEmployeeId"
    ],
    "properties":{
        "objectNum":{
            "description":"Unique reference of the employee in the system.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the employee role is configured",
            "type":"integer",
            "example":3599
        },
        "hierObjNum":{
            "description":"Object number of the hierarchy unit where the employee role is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "roleEmployeeId":{
            "description":"Unique reference of Employee",
            "type":"integer",
            "example":1
        },
        "roleObjNum":{
            "description":"The object number of the employee role",
            "type":"integer",
            "example":1000
        },
        "roleName":{
            "$ref":"#/definitions/RoleNameTranslatedString"
        }
    }
}

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 : RoleNameTranslatedString

Type: object

A string that contains translations of employee role name into multiple languages

Example:

{
    "en-US":"Cashier",
    "de-DE":"Kassierer",
    "ar-AR":"???????? ??????????????"
}

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