Jump to

• Request
• Response

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: string
  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: string
  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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedOrganizationLocations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address line. Used in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The 2-letter country code. For example, FR for France.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The country for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":30,
            "type":"string",
            "description":"The module that created the location.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_HEY",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The address formatted based on the country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier code of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the location. This controls the availability of the location for assignments.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":50,
            "type":"string",
            "description":"The primary direction such as North or East that's used to access the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States postal code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StateCode":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "locationAssociations":{
            "title":"Student Management Location Associations",
            "type":"array",
            "description":"The Student Management location associations are used to associate a location with a Student Management entity.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationLocations-locationAssociations-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object hedOrganizationLocations-locationAssociations-item-response

{
    "title":"Student Management Location Associations",
    "type":"array",
    "description":"The Student Management location associations are used to associate a location with a Student Management entity.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationLocations-locationAssociations-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedOrganizationLocations-locationAssociations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AddressUseId":{
            "type":"integer",
            "description":"The unique identifier of the party site usage association.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedObjectId":{
            "type":"integer",
            "description":"The identifier of the associated object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end date of the location site association.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAssociationId":{
            "type":"integer",
            "description":"The unique identifier for location association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCategoryMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The category name or meaning of the associated Student Management entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationDescription":{
            "type":"string",
            "description":"A description of the associated Student Management entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationName":{
            "type":"string",
            "description":"The name of the associated Student Management entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationPartyId":{
            "type":"integer",
            "description":"The party ID associated with the location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationSiteId":{
            "type":"integer",
            "description":"The unique identifier for the location site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredAddressFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AddressUseTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

HouseTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/personProfileLookups

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

LocationStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

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

locationAssociations

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationLocations/{hedOrganizationLocationsUniqID}/child/locationAssociations

Parameters:

• hedOrganizationLocationsUniqID: $request.path.hedOrganizationLocationsUniqID

The Student Management location associations are used to associate a location with a Student Management entity.

Back to Top