Learning endpoints

[#1]

Filters

Person endpoint

The person endpoint supports the following query string parameters:

changedAfter and  changedUntil

Date Time stamp filter: Date Time should be in UTC Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/persons?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z

Employee endpoint

THIS ENDPOINT HAS BEEN DEPRECATED
Use the endpoints Person and Employment.

Employment endpoint

The employee endpoint supports the following query string parameters

Parameter	description
personCode	Returns a list of employment records filtered by personId https://api.youforce.com/learning/v1.0/employments?personCode=191166
personId	Returns a list of employment records filtered by personId https://api.youforce.com/learning/v1.0/employments?personId=191166
changedAfter and  changedUnil	Date Time stamp filter: Date Time should be in UTC Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/employments?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z​

Cost allocation endpoint

The cost allocation endpoint supports the following query string parameters

Parameter	Description
Id	Returns the cost allocation by id https://api.youforce.com/learning/v1.0/costAllocations/100028%201%200

Organization unit endpoint

The organizationUnits endpoint supports the following query string parameters

Parameter	Description
shortName	Returns a list of all organizationUnit records filtered by shortName https://api.youforce.com/learning/v1.0/organizationUnits?shortName=1010A
changedAfter and  changedUnil	Date Time stamp filter: Date Time should be in UTC Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/organizationUnits?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z​

Role assignment endpoint

The roleAssignments endpoint supports the following query string parameters

Parameter	Description
personId	Returns a list of all role assignment records filtered by personId https://api.youforce.com/learning/v1.0/roleAssignments?personId=1010A
shortName	Returns a list of all role assignment records filtered by shortName https://api.youforce.com/learning/v1.0/roleAssignments?shortName=MGR
changedAfter and  changedUnil	Date Time stamp filter: Date Time should be in UTC Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/roleAssignments?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z​

Job profile endpoint

The jobProfiles endpoint supports the following query string parame

Parameter	Description
shortName	Returns a list of all jobProfile records filtered by shortName https://api.youforce.com/learning/v1.0/jobProfiles?shortName=1010A
changedAfter and  changedUnil	Date Time stamp filter: Date Time should be in UTC Format: YYYY-MM-DDTHH:MM:SS.sssZ Returns (active) person records that have changed within the provided date-time range. https://api.raet.com/learning/v1.0/jobProfiles?changedAfter=2020-06-01T00:00:01.000Z&changedUntil=2020-06-30T00:00:01.000Z​

Pagination of the result set

To reduce the load of an endpoint each endpoint supports paging. If the results of an endpoint contain more than 500 records, the results set will end with a nextLink tag. The nextLink indicates that there are more pages to load. If there is no nextLink at the end of the page, it means that it’s the last page of the result set. The default value is 500 records, but it is possible to use less than that.

Hieronder een voorbeeld waarbij 125 records per pagina wordt opgehaald.

GET https://api.youforce.com//iam/v1.0/persons?take=125

In de nextLink wordt deze page size overgenomen, zodat ook de vervolg pagina's maximaal 125 records bevat. 

U kunt een page size tot maximaal 1000 records opvragen. 

Delete a record

After a record is deleted in the core system, the API will return the record with his id and the flag isDelete = true.

This delete means that the whole record including all version are delete.

For example

{
"id": "907624",
"isDeleted": true,
"shortName": "907624"
}