Qodex.ai

Fetch engagements for person

GET {{baseUrl}}/:personalNumber

AsOfDate supported

Request Params

KeyDatatypeRequiredDescription
asOfDatestringDate on format yyyy-mm-dd
includeWithRoleCodestringInclude engagements with roleCodes
includeWithRoleCodestringInclude engagements with roleCodes
excludeWithRoleCodestringExclude engagements with roleCodes
excludeWithRoleCodestringExclude engagements with roleCodes
includeRoleCodestringInclude roles with roleCodes
includeRoleCodestringInclude roles with roleCodes
excludeRoleCodestringExclude roles with roleCodes
excludeRoleCodestringExclude roles with roleCodes

RESPONSES

status: OK

{"changeDate":"\u003cstring\u003e","engagements":[{"changeDate":"\u003cstring\u003e","commune":"\u003cstring\u003e","companyId":"\u003cstring\u003e","companyName":"\u003cstring\u003e","roles":[{"fromDate":"\u003cstring\u003e","roleCode":"\u003cstring\u003e","roleName":"\u003cstring\u003e"},{"fromDate":"\u003cstring\u003e","roleCode":"\u003cstring\u003e","roleName":"\u003cstring\u003e"}],"statusCode":"\u003cstring\u003e","statusText":"\u003cstring\u003e"},{"changeDate":"\u003cstring\u003e","commune":"\u003cstring\u003e","companyId":"\u003cstring\u003e","companyName":"\u003cstring\u003e","roles":[{"fromDate":"\u003cstring\u003e","roleCode":"\u003cstring\u003e","roleName":"\u003cstring\u003e"},{"fromDate":"\u003cstring\u003e","roleCode":"\u003cstring\u003e","roleName":"\u003cstring\u003e"}],"statusCode":"\u003cstring\u003e","statusText":"\u003cstring\u003e"}],"firstName":"\u003cstring\u003e","fullName":"\u003cstring\u003e","hitCount":"\u003cinteger\u003e","personalNumber":"\u003cstring\u003e","status":{"code":"\u003cinteger\u003e","text":"\u003cstring\u003e"},"surName":"\u003cstring\u003e"}