Schemas Postman

Prepare Department data POST

Prepare Department data

# ENDPOINT
/model/department/prepare
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: department
Type: object
Variable Name Type Format Usage Description
action Action string
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
department department string M Code of a given department
department_order Department Order integer INT64 M Department ordering/sorting code used for reports
department_status Department Status string M Status of a given department
List of allowed values in field (value=>name):
  • 0
    active
  • 1
    closed
description description string M Description of a given record
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
parent_id Parent ID integer INT64 Parent record ID of a given record
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: department
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
action Action string
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
department department string Code of a given department
department_order Department Order integer INT64 Department ordering/sorting code used for reports
department_status Department Status string Status of a given department
description description string Description of a given record
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
parent_id Parent ID integer INT64 Parent record ID of a given record
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
Get Department data by request /api/department/getData/departmentSearchRequest
Fetch Department data by ID /model/department/getDb/{id}
Validate Department data /model/department/validate
Create/update Department data /model/department/putDb
Delete Department data by ID /api/department/deleteItem/{id}