OrgInfo

Name OrgInfo
Usage OrganizationService
getOrg getOrgsByIds searchForOrgs validateOrg createOrg updateOrg
Type Complex

Description

Detailed information about a single organization.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
longName Long Name String Full name of the organization. Required   One No  
longDescr Short Description RichTextInfo Narrative description of the organization.     One No  
shortName Short Name String Shortened format or abbreviation of the organization's name.     One No  
sortName Sort Name String The name used for sorting, for cases when alphabetical sorting
by shortName or longName is undesirable.		     One No  
shortDescr Short Description RichTextInfo A brief description of the organization.     One No  
orgCodes Org Codes OrgCodeInfoList A list of organization code info structures. These are
structures so that many different types of codes can be
associated with the org. This allows them to be put into
categories.		     Many No  
effectiveDate Effective Date Date Date/time this object became effective. Must be less than or
equal to the expirationDate specified.		     One No  
expirationDate Expiration Date Date Date/time this relationship is no longer effective. Must be
greater than or equal to the effectiveDate specified.		     One No  
meta Meta MetaInfo Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 Required on updates Read only One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No