Configuration and Content API Guide

Add Employee Roles

post

/config/sim/v1/employees/employeeRoles

Assign a role to an Employee at the specified hierarchy unit .

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Employee Role Insert Request body

Root Schema : EmployeeRoleInsertRequestBody

Type: object

Model for an Employee Role Insert Request body.

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit where the employee role is configured

Example: 3599
objectNum(required): integer

Unique reference of the employee in the system.

Example: 1
roleObjNum(required): integer

The object number of the role assigned to the employee

Example: 1000

{
    "description":"Model for an Employee Role Insert Request body.",
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "roleObjNum"
    ],
    "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
        },
        "roleObjNum":{
            "description":"The object number of the role assigned to the employee",
            "type":"integer",
            "example":1000
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Employee Role object of the organization.

Root Schema : EmployeeRoleResponse

Type: object

Model for Employee Role Insert and Update Response Body

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit where the employee role is configured

Example: 3599
objectNum(required): integer

Unique reference of the employee in the system.

Example: 1
roleEmployeeId(required): integer

Unique reference of Employee Role Association

Example: 1
roleObjNum(required): integer

The object number of the role assigned to the employee

Example: 1000

{
    "description":"Model for Employee Role Insert and Update Response Body",
    "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
        },
        "roleEmployeeId":{
            "description":"Unique reference of Employee Role Association",
            "type":"integer",
            "example":1
        },
        "roleObjNum":{
            "description":"The object number of the role assigned to the employee",
            "type":"integer",
            "example":1000
        }
    }
}

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