{"id":12633,"date":"2024-06-25T14:16:47","date_gmt":"2024-06-25T11:16:47","guid":{"rendered":"https:\/\/availo.app\/?post_type=documents&#038;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 class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Link: <\/strong><a href=\"https:\/\/availo-testingintegrationapi.t2.sa\/api\/Organization\/UploadOrganizaionStructure\" target=\"_blank\" rel=\"noopener\">{Base_Url}\/<\/a>api\/ User\/ AddUsers<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Method Type: <\/strong>POST<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Content Type: <\/strong>Application\/Json<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Description: <\/strong>sync users\u2019 information with Availo system<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Request Object: <\/strong>List of below objects<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Request object:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td rowspan=\"2\">Field<\/td><td colspan=\"2\">Required<\/td><td rowspan=\"2\"><br>Type<\/td><td rowspan=\"2\">Description<\/td><\/tr><tr><td>Add<\/td><td>Update<\/td><\/tr><tr><td><br>UserName<\/td><td><br><br>Yes<\/td><td><br><br>Yes<\/td><td><br><br>String<\/td><td><br><br>User Name<\/td><\/tr><tr><td><br><br>JobNumber<\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>User Job Number<\/td><\/tr><tr><td><br><br>FirstName<\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>User First Name<\/td><\/tr><tr><td><br><br>LastName<\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>User Last Name<\/td><\/tr><tr><td><br><br>JobTitle<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>User Job Title&nbsp;<\/td><\/tr><tr><td><br><br>PhoneNumber<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br>User Phone Number<br>** Required if the user is department-manager<\/td><\/tr><tr><td><br><br>IsDeleted<\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>Boolean<\/td><td><br><br>Is user deleted?<\/td><\/tr><tr><td><br><br>IsActive<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>Boolean<\/td><td><br><br>Is user active?<\/td><\/tr><tr><td><br><br>DepartmentCodeToDelete<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>List&lt;string&gt;<\/td><td><br><br>List of departments id want to<\/td><\/tr><tr><td><br><br>departmentUser<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br>Object (please find the below details table)&nbsp;<\/td><td><br>List of user department information&nbsp;&nbsp;<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td rowspan=\"2\"><br>Field<\/td><td colspan=\"2\">Required<\/td><td rowspan=\"2\">&nbsp;Type<\/td><td rowspan=\"2\"><br>Description<\/td><\/tr><tr><td>Add<\/td><td>Update<\/td><\/tr><tr><td><br><br>DepartmentCode<\/td><td><br><br>Yes<\/td><td><br><br>Yes<\/td><td><br><br>String<\/td><td><br><br>Department id&nbsp;<\/td><\/tr><tr><td><br><br>DepartmentNameArabic<br><\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>Name in Arabic&nbsp;&nbsp;<\/td><\/tr><tr><td><br><br>DepartmentNameEnglish<br><\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>Name in English<\/td><\/tr><tr><td><br><br>IsDepartmentManager<br><\/td><td><br><br>Yes<\/td><td><br><br>Yes<\/td><td><br><br>Boolean<\/td><td><br><br>Is user department manager<\/td><\/tr><tr><td><br><br>IsDeleted<br><\/td><td><br><br>Yes<\/td><td><br><br>No<\/td><td><br><br>Boolean<\/td><td><br><br>Is Deleted<\/td><\/tr><tr><td><br><br>ParentDepartmentCode<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>Parent department Id<\/td><\/tr><tr><td><br><br>ParentIsDeleted<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>Boolean<\/td><td><br><br>Is Deleted**Required if the parent code is filled in<\/td><\/tr><tr><td><br><br>ParentDepartmentNameArabic<\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>Name in Arabic<\/td><\/tr><tr><td><br><br>ParentDepartmentNameEnglish<br><\/td><td><br><br>No<\/td><td><br><br>No<\/td><td><br><br>String<\/td><td><br><br>Name in English<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Sample Request:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/lh7-us.googleusercontent.com\/docsz\/AD_4nXceRsdaUKGVcOC6wse0skmIAo96SaOr2loeu8OSQUoD-gi6kBuC3ZJOWV3uj-thf630yVzkTEBWh5yS-tTpNYtGISagoH5BlpnI7SnPtsMLsC_ac1vHkDDV0Ky22sTs9TYAd-tZyWx0a38ASxA6_LD-hbRxZj4gA1bSljxsb3Z8Tff_lU9uisw?key=WUHE52LkYm1PA8Dh8uOA8Q\" alt=\"\"\/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\"><strong><\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Response object:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Field<\/td><td>Required<\/td><td>Type<\/td><td>Description<\/td><\/tr><tr><td>Data<\/td><td><br>No<\/td><td><br>Boolean<\/td><td><\/td><\/tr><tr><td><br>Status<\/td><td><br>Yes<\/td><td><br><br>Boolean<\/td><td>if the request is a success or not<\/td><\/tr><tr><td><br>message<\/td><td><br>No<\/td><td><br>String<\/td><td>The error message that returns from request<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Sample Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/lh7-us.googleusercontent.com\/docsz\/AD_4nXe541u3FZ1MKpdsz8QodruGobM89XJnxIvOqSI8e_c58xkQoHt1t9-GcGrTQfLq3A3OtfqHRq8-1YAfDD_k2ksKhdCbCNr9NWKxnR_InD8W_Gg29qsnOI4SOf3thMtFsOYb3uIaKqobwj_0O54iYz3dWD8LVY-rgWJVcoTbaOxN_hB9tlsoTA?key=WUHE52LkYm1PA8Dh8uOA8Q\" alt=\"\"\/><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>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 [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":12458,"menu_order":0,"template":"","class_list":["post-12633","documents","type-documents","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12633","targetHints":{"allow":["GET"]}}],"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}]}}