Get all Student Management locations
get
/fscmRestApi/resources/11.13.18.05/hedOrganizationLocations
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- ByKeywordFinder Finds the location using the provided keyword. The provided keyword is used to search for Student Management locations using the location name, address line one, postal code, and city of the location table. It returns active locations.
Finder Variables- Keyword; string; A string keyword used to search the location name, address one, postal code, and city of the location table.
- LocationCodeOrName; string; Ensures that the location with the code will be included in the response payload.
- PrimaryKey Finds the location with the specified primary key.
Finder Variables- LocationId; integer; Unique Identifier of the location record.
- ByKeywordFinder Finds the location using the provided keyword. The provided keyword is used to search for Student Management locations using the location name, address line one, postal code, and city of the location table. It returns active locations.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AddrElementAttributeFive; string; The additional address element to support flexible address format.
- AddrElementAttributeFour; string; The additional address element to support flexible address format.
- AddrElementAttributeOne; string; The additional address element to support flexible address format.
- AddrElementAttributeThree; string; The additional address element to support flexible address format.
- AddrElementAttributeTwo; string; The additional address element to support flexible address format.
- AddressFour; string; The fourth line of the address.
- AddressLinesPhonetic; string; The phonetic or Kana representation of the Kanji address line. Used in Japan.
- AddressOne; string; The first line of the address.
- AddressThree; string; The third line of the address.
- AddressTwo; string; The second line of the address.
- AddressUseTypeCode; string; 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; 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; The building name or number in the address.
- City; string; The city for the address.
- CountryCode; string; The 2-letter country code. For example, FR for France.
- County; string; The country for the address.
- CreatedBy; string; The user who created the row.
- CreatedByModule; string; The module that created the location.
- CreationDate; string; The date the row was created.
- FloorNumber; string; The floor number at a given address or in a particular building when building number is provided.
- HouseType; string; The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
- HouseTypeMeaning; string; The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
- LastUpdateDate; string; The date the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- LocationCode; string; The unique identifier code of the location.
- LocationDirections; string; The directions to the location.
- LocationId; integer; The unique identifier for the location.
- LocationName; string; The name of the location.
- LocationStatusCode; string; The status code of the location. This controls the availability of the location for assignments.
- LocationStatusMeaning; string; The status of the location.
- Position; string; The primary direction such as North or East that's used to access the location.
- PostalCode; string; The postal code for the address.
- PostalPlusFourCode; string; The four digit extension to the United States postal code.
- Province; string; The province for the address.
- StateCode; string; The state for the address.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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