API 2.0 - WebAPI til CCS Connector Database
Metoder til at kalde API’et:
| Command | Url | Required fields | Description |
|---|---|---|---|
POST |
https://apiurl/V1.0/systems/d7689e2b-941a-4cd3-bb24-55cddee5429/Persons/dn |
ID, Handled, Firstname, Lastname |
Creates or Updates a Person (match on Id column) |
POST |
https://apiurl/V1.0/systems/d7689e2b-941a-4cd3-bb24-55cddee5429/Persons |
Id, Handled, Firstname, Lastname |
Updates a list of persons (match on Id column) |
GET |
Returns name, ID, description, priority for all custom systems |
||
GET |
https://apiurl/V1.0/systems/d7689e2b-941a-4cd3-bb24-55cddee5429/Persons |
Returns all persons for system with id d7689e2b-941a-4cd3-bb24-55cddee5429 |
|
GET |
https://apiurl/V1.0/systems/d7689e2b-941a-4cd3-bb24-55cddee5429/Persons/dn |
Returns person with id DN |
Krav:
-
ID-kolonne angives til et entydigt ID for denne person. Det kan være EmployeeID, Initialer, E-mail-addresse eller et andet ID, der skal være entydigt for personer i dette system.
-
Manager bruger ID-kolonne som reference (format skal matche ID-kolonne)
-
Organisatoriske enheder (firma, afdeling, bærer, stilling, jobtitel, division, lokation) oprettes og opdateres automatisk i Compliance Suite. Hvis du vil understøtte opdateringer, skal ID-kolonnen (dvs. DepartmentID, osv.) udfyldes, ellers vil der blive oprettet en ny afdeling på non-match.
-
Hvis du vil slette en person, skal du angive DeactivateOn-dato (foretrukket) eller angive PersonStatusName (brug kun i scenarious, hvor du ikke bør kunne udføre en manuel deaktivering i Compliance Suite).
-
Initialer genereres automatisk og opdateres i denne tabel, hvis de ikke er angivet.
-
Angiv det Handled flag. Se nedenfor.
Felter
| Name | Type | Description | Example |
|---|---|---|---|
ID |
Text |
Unique string value for the person |
6ca7b087-4315-41d3-b226-b1b2d8906d4b |
Handled |
Number |
A number indicating the status of the table entry. See Handled section below for details. |
1 |
PersonTypeName |
Reference |
The type of the person in Compliance Suite |
Employee |
PersonStatusName |
Reference |
The status of the person in Compliance Suite |
Activate |
CompanyName |
Reference |
Specifies which company the person belongs to |
<company name> |
CompanyId |
Reference |
Specifies which company the person belongs to |
13 |
FirstName |
Text |
First name |
Anders |
LastName |
Text |
Last name |
Andersen |
Name |
Text |
Full name |
Anders Andersen |
Initials |
Text |
Initials used to logon to the different systems |
aand |
EmployeeId |
Text |
Special ID for the employee / person |
1 |
EmployeeCardId |
Text |
Special ID for the employee-card / person-card |
10 |
Salutation |
Reference |
Specifies the salutation for person |
Mr. |
Phone |
Text |
Phone number |
+45 12345678 |
Cellphone |
Text |
Mobile phone number |
+45 12345679 |
PositionName |
Reference |
Specifies which position the person has |
Employee |
PositionId |
Reference |
Specifies which position the person has |
12 |
JobTitleName |
Reference |
Specifies which job-title the person has been assigned |
Assistant |
JobTitleId |
Reference |
Specifies which job-title the person has been assigned |
3 |
DepartmentName |
Reference |
Specifies which department the person belongs to |
Administration |
DepartmentId |
Reference |
Specifies which department the person belongs to |
2 |
CostCenterName |
Reference |
Specifies which cost-center the person belongs to |
Default |
CostCenterId |
Reference |
Specifies which cost-center the person belongs to |
22 |
DivisionName |
Reference |
Specifies which division the person belongs to |
Administration |
DivisionId |
Reference |
Specifies which division the person belongs to |
33 |
Manager |
Reference |
Specifies who the manager for the person is by Id for that person |
7ca7b087-4315-41d3-b226-b1b2d8906d4c |
LocationName |
Reference |
Specifies which location the person is located |
Kongens Nytorv 8 |
LocationId |
Reference |
Specifies which location the person is located |
23 |
PreferredLanguageName |
Reference |
Specifies the preferred language for the person |
Danish - Denmark |
LeaveReturnDate |
Date |
A date for leave of absence for the person |
01-09-2019 |
Description |
Text |
Description of person |
This user is the most important employee |
CategoryName |
Reference |
Categorization of person |
Blue |
ActivateOn |
Date |
A date for activation |
01-01-2018 |
DeactivateOn |
Date |
A date for deactivation |
31-12-2019 |
PrivatePhone |
Text |
Private phone number |
+45 99999999 |
PrivateMobilePhone |
Text |
Private mobile phone number |
+45 99999990 |
PrivateEmail |
Text |
Private E-mail |
|
PrivateAddress |
Text |
Private Address |
Farum Hovedgade 71 |
PrivateZipCode |
Text |
Private Zipcode |
3520 |
PrivateCity |
Text |
Private City |
Farum |
PrivateCountryName |
Reference |
Private Country |
DK |
DateOfBirth |
Date |
A date of birth |
01-03-1995 |
ModifiedOn |
Date and time |
Change date for the entity. This field is not used by Compliance Suite to synchronize. Instead, the Handled field is used. |
01-03-2019 13:01:00 |
CreatedOn |
Date and time |
Creation date for the entity. This field is not used by Compliance Suite to synchronize. |
01-01-2019 00:00:00 |
Bemærkninger
Tabellen ovenfor indeholder alle data, der kan ses fra personkortet i Compliance Suite.
-
Navn: Navnet på kolonnen i databasen
-
Type: Angiver kolonnens type.
-
Tekst: Teksten overføres direkte fra kolonnen til det tilknyttede felt i Compliance Suite.
-
Reference: Den tilhørende enhed søges i Compliance Suite fra navnet og forsøger at forbinde referencen med personen.
-
Dato: Kun den dato, der er angivet i UTC-tid.
-
Dato og klokkeslæt: Indeholder den dato og det klokkeslæt, der er angivet i UTC-klokkeslæt.
-
Beskrivelse: Beskriver, hvad feltet repræsenterer.
-
Eksempel: Eksempel på, hvad der kunne skrives i databasen.
Bemærkninger til gennemførelsen:
API’en bruger Entra ID SQL-databasetabeller som en beholder til opdateringer. I stedet for at bruge REST API, en direkte opdateringer og læser til disse tabeller er muligt, ved hjælp af de samme begreber som API.
Når en person opdateres eller oprettes, søger et tidsbaseret job, der kører hvert minut, efter nye poster og ændringer af eksisterende. Disse ændringer vil derefter blive afspejlet og vist i Compliance Suite i overensstemmelse hermed.
Handled-kolonnen
Ændringerne spores ved hjælp af kolonnen Handled. Nedenfor vises de mulige værdier for kolonnen Handled:
| Scenario | Value | Set by | Meaning |
|---|---|---|---|
Inbound |
0 (same as null) |
Compliance Suite |
The column is synchronized. |
Inbound |
1 |
The customer |
"Dirty" = The column is changed and ready to be processed. |
Inbound |
2 |
Compliance Suite |
"Handling" = Compliance Suite is in progress of handling the change. |
Inbound |
3 |
Compliance Suite |
"Error" = An error occured and the values are not synchronized correct. Check Compliance Suite History log. |
Example of call:
POST
https://apiurl/V1.0/systems/d7689e2b-941a-4cd3-bb24-55cddee5429/Persons/cd819d15-dca8-4ee2-a019-f38a1b93e589
Content-type: application/json
{
"id" : "cd819d15-dca8-4ee2-a019-f38a1b93e589",
"handled" : "1",
"persontypename" : "Employee",
"PersonStatusname" : "Active",
"companyname" : "<company name>",
"firstname" : "Anders",
"lastname" : "Andersen",
"name" : "Anders Andersen",
"initials" : "aand",
"employeeid" : "1",
"employeecardid" : "10",
"salutation" : "Mr.",
"phone" : "+45 12345678",
"cellphone" : "+45 12345679",
"positionname" : "Employee",
"jobtitlename" : "Assistant",
"departmentname" : "Administration",
"costcentername" : "Default",
"divisionname" : "Administration",
"manager" : "7ca7b087-4315-41d3-b226-b1b2d8906d4c",
….
}