Get a Student Management location
get
/fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}
Request
Path Parameters
-
hedOrganizationLocationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Management Locations resource and used to uniquely identify an instance of Student Management Locations. The client should not generate the hash key value. Instead, the client should query on the Student Management Locations collection resource in order to navigate to a specific instance of Student Management Locations to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hedOrganizationLocations-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address line. Used in Japan. -
AddressOne: string
Title:
Address Line 1
Maximum Length:240
The first line of the address. -
AddressThree: string
Title:
Address Line 3
Maximum Length:240
The third line of the address. -
AddressTwo: string
Title:
Address Line 2
Maximum Length:240
The second line of the address. -
AddressUseTypeCode: string
Maximum Length:
30
The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AddressUseTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city for the address. -
CountryCode: string
Title:
Country
Maximum Length:2
The 2-letter country code. For example, FR for France. -
County: string
Title:
County
Maximum Length:60
The country for the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Read Only:
true
Maximum Length:30
Default Value:ORA_HEY
The module that created the location. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The address formatted based on the country code. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The multiline display for the formatted address. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationAssociations: array
Student Management Location Associations
Title:
Student Management Location Associations
The Student Management location associations are used to associate a location with a Student Management entity. -
LocationCode: string
Title:
Code
Maximum Length:100
The unique identifier code of the location. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
LocationName: string
Title:
Location Name
Maximum Length:100
The name of the location. -
LocationStatusCode: string
Maximum Length:
30
Default Value:ORA_ACTIVE
The status code of the location. This controls the availability of the location for assignments. -
LocationStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the location. -
Position: string
Title:
Position
Maximum Length:50
The primary direction such as North or East that's used to access the location. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code for the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States postal code. -
Province: string
Title:
Province
Maximum Length:60
The province for the address. -
StateCode: string
Title:
State
Maximum Length:60
The state for the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Student Management Location Associations
Type:
array
Title:
Student Management Location Associations
The Student Management location associations are used to associate a location with a Student Management entity.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : hedOrganizationLocations-locationAssociations-item-response
Type:
Show Source
object
-
AddressUseId: integer
(int64)
Read Only:
true
The unique identifier of the party site usage association. -
AddressUseTypeCode: string
Read Only:
true
Maximum Length:30
The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AddressUseTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AssociatedObjectId: integer
(int64)
Read Only:
true
The identifier of the associated object. -
AssociationEndDate: string
(date)
Read Only:
true
The end date of the location site association. -
AssociationStartDate: string
(date)
Read Only:
true
The start date of the location site association. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationAssociationId: integer
(int64)
Read Only:
true
The unique identifier for location association. -
OrganizationCategoryCode: string
Read Only:
true
Maximum Length:30
The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
OrganizationCategoryMeaning: string
Read Only:
true
Maximum Length:80
The category name or meaning of the associated Student Management entity. -
OrganizationDescription: string
Read Only:
true
A description of the associated Student Management entity. -
OrganizationName: string
Read Only:
true
The name of the associated Student Management entity. -
OrganizationPartyId: integer
(int64)
Read Only:
true
The party ID associated with the location. -
OrganizationSiteId: integer
(int64)
Read Only:
true
The unique identifier for the location site. -
PreferredAddressFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the preferred address. The default value is: false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AddressUseTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{AddressUseTypeCode}%2CLookupType%3DPARTY_SITE_USE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: AddressUseTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- HouseTypeLOV
-
Parameters:
- finder:
LookupTypeIsActiveFinder%3BLookupType%3DHZ_HOUSE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: HouseType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LocationStatusLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_LOCATION_STATUS%2CLookupCode%3D{LocationStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: LocationStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- locationAssociations
-
Parameters:
- hedOrganizationLocationsUniqID:
$request.path.hedOrganizationLocationsUniqID
The Student Management location associations are used to associate a location with a Student Management entity. - hedOrganizationLocationsUniqID: