Person
A Person.
Like all OsidObjects,
Person is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
salutation |
displaytext | the title | |
givenName |
displaytext | the given name | |
preferredName |
displaytext | the preferred name | |
forenameAliases |
displaytext | forname aliases | |
middleNames |
displaytext | the middle names | |
surname |
displaytext | the surname | |
surnameAliases |
displaytext | the surname aliases | |
generationQualifier |
displaytext | the generation qualifier | |
qualificationSuffix |
displaytext | the generation qualifier | |
hasBirthDate |
boolean | true if a birth date is available, false
otherwise |
|
birthDate |
datetime | the date of birth | |
isDeceased |
boolean | true if this person is dead, false if still
kicking |
|
deathDate |
datetime | the date of death | |
institutionalIdentifier |
string | the institutional identifier |
Organization
An Organization.
Like all OsidObjects,
Organization is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| Name | Syntax | Many | Description |
|---|---|---|---|
displayLabel |
displaytext | the display label |
Position
A Position in an
Organization.
Like all OsidObjects,
Position is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| Name | Syntax | Many | Description |
|---|---|---|---|
organizationId |
id | the Organization Id |
|
organization |
Organization | the Organization |
|
title |
displaytext | the position title | |
levelId |
id | the Grade Id |
|
level |
Grade | the Grade |
|
hasQualifications |
boolean | true if qualifications are available, false
otherwise |
|
qualificationIds |
id | ⋆ | a list of objective Ids |
qualifications |
Objective | ⋆ | the Objectives |
targetAppointments |
cardinal | the number of appointments | |
requiredCommitment |
cardinal | the required percentage commitment | |
hasSalaryRange |
boolean | true if a salary range is available, false
otherwise |
|
lowSalaryRange |
Currency | the low slaary | |
midpointSalaryRange |
Currency | the midpoint slaary | |
highSalaryRange |
Currency | the high slaary | |
compensationFrequency |
duration | the frequency | |
isExempt |
boolean | true if this position is exempt, false is
non-exempt |
|
hasBenefits |
boolean | true if this position has benefits, false
otherwise |
|
benefitsType |
type | the benefits type |
Appointment
An Appointment relates a
Position to a Position.
Like all OsidObjects,
Appointment is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
personId |
id | the person Id |
|
person |
Person | the Person |
|
positionId |
id | the Position Id |
|
position |
Position | the Position |
|
commitment |
cardinal | the percentage commitment | |
title |
displaytext | the title | |
hasSalary |
boolean | true if a salary is available, false otherwise |
|
salary |
Currency | the slaary | |
salaryBasis |
cardinal | the number of months |
Realm
A Realm represents a collection of
persons. Like all OSID objects, a Realm
is identified by its Id and any persisted
references should use the Id.
Like all OsidObjects,
Realm is managed by its
OsidSessions and may not be accessed by
concurrent processing threads.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |