{"id":12633,"date":"2024-06-25T14:16:47","date_gmt":"2024-06-25T11:16:47","guid":{"rendered":"https:\/\/availo.app\/?post_type=documents&p=12633"},"modified":"2024-06-25T14:16:50","modified_gmt":"2024-06-25T11:16:50","slug":"sync-users","status":"publish","type":"documents","link":"https:\/\/availo.app\/en\/documents\/%d9%85%d8%b3%d8%aa%d9%86%d8%af%d8%a7%d8%aa-api\/sync-users\/","title":{"rendered":"Sync Users"},"content":{"rendered":"\n

<\/p>\n\n\n\n

Link: <\/strong>{Base_Url}\/<\/a>api\/ User\/ AddUsers<\/p>\n\n\n\n

Method Type: <\/strong>POST<\/p>\n\n\n\n

Content Type: <\/strong>Application\/Json<\/p>\n\n\n\n

Description: <\/strong>sync users\u2019 information with Availo system<\/p>\n\n\n\n

Request Object: <\/strong>List of below objects<\/p>\n\n\n\n

<\/p>\n\n\n\n

Request object:<\/strong><\/p>\n\n\n\n

Field<\/td>Required<\/td>
Type<\/td>
Description<\/td><\/tr>
Add<\/td>Update<\/td><\/tr>

UserName<\/td>


Yes<\/td>


Yes<\/td>


String<\/td>


User Name<\/td><\/tr>


JobNumber<\/td>


Yes<\/td>


No<\/td>


String<\/td>


User Job Number<\/td><\/tr>


FirstName<\/td>


Yes<\/td>


No<\/td>


String<\/td>


User First Name<\/td><\/tr>


LastName<\/td>


Yes<\/td>


No<\/td>


String<\/td>


User Last Name<\/td><\/tr>


JobTitle<\/td>


No<\/td>


No<\/td>


String<\/td>


User Job Title <\/td><\/tr>


PhoneNumber<\/td>


No<\/td>


No<\/td>


String<\/td>

User Phone Number
** Required if the user is department-manager<\/td><\/tr>


IsDeleted<\/td>


Yes<\/td>


No<\/td>


Boolean<\/td>


Is user deleted?<\/td><\/tr>


IsActive<\/td>


No<\/td>


No<\/td>


Boolean<\/td>


Is user active?<\/td><\/tr>


DepartmentCodeToDelete<\/td>


No<\/td>


No<\/td>


List<string><\/td>


List of departments id want to<\/td><\/tr>


departmentUser<\/td>


No<\/td>


No<\/td>

Object (please find the below details table) <\/td>

List of user department information  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Field<\/td>
Required<\/td> Type<\/td>
Description<\/td><\/tr>
Add<\/td>Update<\/td><\/tr>


DepartmentCode<\/td>


Yes<\/td>


Yes<\/td>


String<\/td>


Department id <\/td><\/tr>


DepartmentNameArabic
<\/td>


Yes<\/td>


No<\/td>


String<\/td>


Name in Arabic  <\/td><\/tr>


DepartmentNameEnglish
<\/td>


Yes<\/td>


No<\/td>


String<\/td>


Name in English<\/td><\/tr>


IsDepartmentManager
<\/td>


Yes<\/td>


Yes<\/td>


Boolean<\/td>


Is user department manager<\/td><\/tr>


IsDeleted
<\/td>


Yes<\/td>


No<\/td>


Boolean<\/td>


Is Deleted<\/td><\/tr>


ParentDepartmentCode<\/td>


No<\/td>


No<\/td>


String<\/td>


Parent department Id<\/td><\/tr>


ParentIsDeleted<\/td>


No<\/td>


No<\/td>


Boolean<\/td>


Is Deleted**Required if the parent code is filled in<\/td><\/tr>


ParentDepartmentNameArabic<\/td>


No<\/td>


No<\/td>


String<\/td>


Name in Arabic<\/td><\/tr>


ParentDepartmentNameEnglish
<\/td>


No<\/td>


No<\/td>


String<\/td>


Name in English<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Sample Request:<\/strong><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

<\/strong><\/p>\n\n\n\n

<\/p>\n\n\n\n

Response object:<\/strong><\/p>\n\n\n\n

Field<\/td>Required<\/td>Type<\/td>Description<\/td><\/tr>
Data<\/td>
No<\/td>

Boolean<\/td>
<\/td><\/tr>

Status<\/td>

Yes<\/td>


Boolean<\/td>
if the request is a success or not<\/td><\/tr>

message<\/td>

No<\/td>

String<\/td>
The error message that returns from request<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Sample Response:<\/strong><\/p>\n\n\n\n

\"\"\/<\/figure>\n","protected":false},"excerpt":{"rendered":"

Link: {Base_Url}\/api\/ User\/ AddUsers Method Type: POST Content Type: Application\/Json Description: sync users\u2019 information with Availo system Request Object: List of below objects Request object: Field Required Type Description Add Update UserName Yes Yes String User Name JobNumber Yes No String User Job Number FirstName Yes No String User First Name LastName Yes No String […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":12458,"menu_order":0,"template":"","aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12633"}],"collection":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents"}],"about":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/types\/documents"}],"author":[{"embeddable":true,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/users\/2"}],"version-history":[{"count":0,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12633\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12458"}],"wp:attachment":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/media?parent=12633"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}