Create User Bulk

This end point is use for create users

[POST] /ruangkerja/users/create-bulk

Information

This API is a function for create multiple users in single operation.

Headers

Name	Type	Example	Required	Description
Authorization	string	access_token	YES	Token of authentication. Get from Authentication API
Accept	string	application/json	YES	Defines the message format that is expected by the client
Content-Type	string	application/json	YES	Defines the message format of the request body that is sent by the client

Parameter

Name	Type	Required	Location	Description
employeeID	string	YES	body	Employee ID of user. Allowed format: Alphabet (a-z, A-Z), Numeric (0-9)
name	string	YES	body	Name of user
username	string	OPTIONAL	body	Username is used by users to sign in. Allowed format: Alphabet (a-z,A-Z) Numerical (0-9)
email	string	OPTIONAL	body	Email of user. Email is required if phone empty
phone	string	OPTIONAL	body	Phone of user. Phone is required if email empty
password	string	OPTIONAL	body	Password of user. Password will be send to email, If empty the password will be random
isActive	bool	YES	body	Status of user
tagSerials	[]string	OPTIONAL	body	Tag serials
organizationSerial	string	OPTIONAL	body	Organization serial of user

Note: Email and phone number can be entered both

Example cURL Request

curl --location --request POST 'https://api.ruangkerja.id/ruangkerja/users/create-bulk' \
--header 'Authorization: access_token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "items": [
        {
            "employeeID": "EMPLY001",
            "name": "John Doe",
            "username": null,
            "email": "[email protected]",
            "phone": "6281122334455",
            "password": null,
            "isActive": true,
            "tagSerials": ["RUKRTAG-9WHL0JGP"],
            "organizationSerial": "COMPFJLYTHWL"
        }
    ]
}'

Example Success Response

{
    "data": {
        "failedItems": [],
        "successItems": [
            {
                "payload": {
                    "employeeID": "EMPLY001",
                    "name": "John Doe",
                    "username": null,
                    "email": "[email protected]",
                    "phone": "6281122334455",
                    "password": null,
                    "isActive": true,
                    "tagSerials": ["RUKRTAG-9WHL0JGP"]
                },
                "response": {
                    "serial": "OPENAPI9Z7ZIHIFW"
                }
            }
        ]
    },
    "status": "success",
    "message": "success"
}

Example Failed Response

{
    "data": {
        "failedItems": [
            {
                "error": {
                    "detail": "employee id already been taken",
                    "errorCode": 10101,
                    "message": "USER_EMPLOYEE_ID_EXISTS"
                },
                "payload": {
                    "employeeID": "EMPLY001",
                    "name": "John Doe",
                    "username": null,
                    "email": "[email protected]",
                    "phone": "6281122334455",
                    "password": null,
                    "isActive": true,
                    "tagSerials": ["RUKRTAG-9WHL0JGP"]
                }
            }
        ],
        "successItems": []
    },
    "status": "success",
    "message": "success"
}

Create User Bulk

Information #

Headers #

Parameter #

Example cURL Request #

Example Success Response #

Example Failed Response #

Information

Headers

Parameter

Example cURL Request

Example Success Response

Example Failed Response