EXPORT - Get a user's organization units
Resource URL
URL: user/export/organizationUnits
Parameters
string username | Username |
string password | Password |
int pageNumber | Page number to retrieve |
int pageSize | Maximum number of elements on each page |
Return value
organizationUnitRegistrations | A list containing organization unit registrations for a specific user |
organizationUnitRegistrations[].id | ID of the user |
organizationUnitRegistrations[].externalId | External ID of the user |
organizationUnitRegistrations[].registrations | Organization units registrations for the user |
organizationUnitRegistrations[].registrations[].name | Name of the unit |
organizationUnitRegistrations[].registrations[].externalId | External ID of the unit |
organizationUnitRegistrations[].registrations[].status | Status for a relation between a user and a organization unit. One of values: ACTIVE, INACTIVE or NEEDS_CONFIRMATION |
pageNumber | Number of the current page |
pageSize | Size of the current page |
Example request
URL | https://www.trainingportal.no/mintra/rest/user/export/organizationUnits |
POST DATA | username=username&password=secret&pageNumber=10&pageSize=20 |
{
"organizationUnitRegistrations": [
{
"id": 123,
"externalId: "abc",
"registrations": [
{
"name":"Technical",
"externalId":"tech001",
"status":"ACTIVE"
},
{
"name":"HR",
"externalId":"hr001",
"status":"NEEDS_CONFIRMATION"
}
]
}
],
"pageNumber": 10,
"pageSize": 20
}