Jump to

• Request
• Response

Get all facilities

get

/fscmRestApi/resources/11.13.18.05/academicFacilities

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 all facilities matching the specified keyword.
    Finder Variables
    • Keyword; string; The keyword that's used to search against the facility type, building name, and facility short code.
    • SectionScheduleId; integer; The identifier of the section meeting to which the facilities are being assigned.
  • PrimaryKey Finds the facility with the specified primary key.
    Finder Variables
    • FacilityId; integer; Unique identifier of the facility record.
• 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:
  

  • BuildingCode; string; The unique alternate identifier of the building.
  • BuildingDescription; string; The description of the building.
  • BuildingId; integer; The unique identifier of the building.
  • BuildingName; string; The name of the building.
  • BuildingStatus; string; The meaning of the building status code.
  • BuildingStatusCode; string; A list of accepted values is defined in the lookup type ORA_HER_BUILDING_STATUS_CODE.
  • BuildingTimeZone; string; The name of the time zone.
  • BuildingTimeZoneCode; string; The time zone of the building.
  • CreatedBy; string; The user who created the row.
  • CreationDate; string; The date the row was created.
  • FacilityCapacity; integer; The maximum capacity of the facility.
  • FacilityCode; string; The unique alternate identifier for the facility.
  • FacilityDescription; string; The description of the facility.
  • FacilityId; integer; The unique identifier of the facility.
  • FacilityRoomNumber; string; The room number of the facility.
  • FacilityStatus; string; The meaning of the facility type code.
  • FacilityStatusCode; string; A list of accepted values is defined in the lookup type ORA_HER_FACILITY_STATUS_CODE.
  • FacilityType; string; The meaning of the facility type code.
  • FacilityTypeCode; string; A list of accepted values is defined in the lookup type ORA_HER_FACILITY_TYPE_CODE.
  • LastUpdateDate; string; The date the row was last updated.
  • LastUpdatedBy; string; The user who last updated the row.
• 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 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 : academicFacilities

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/academicFacilities-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object academicFacilities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/academicFacilities-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 : academicFacilities-item-response

Type: object

Show Source

• assignments: array Drop Scheme Settings Assignments
  Title: Drop Scheme Settings Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• blackoutDates: array Blackout Dates
  Title: Blackout Dates

  The blackout dates resource is used to list the dates the facility is unavailable.
• BuildingCode: string
  Title: Code

  Read Only: true

  Maximum Length: 6

  The unique alternate identifier of the building.
• BuildingDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the building.
• BuildingId: integer (int64)
  Title: Building

  The unique identifier of the building.
• BuildingName: string
  Title: Building Name

  Read Only: true

  Maximum Length: 100

  The name of the building.
• BuildingStatus: string
  Title: Building Status

  Read Only: true

  Maximum Length: 80

  The meaning of the building status code.
• BuildingStatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  A list of accepted values is defined in the lookup type ORA_HER_BUILDING_STATUS_CODE.
• BuildingTimeZone: string
  Title: Building Time Zone

  Read Only: true

  Maximum Length: 80

  The name of the time zone.
• BuildingTimeZoneCode: string
  Title: Building Time Zone Code

  Read Only: true

  Maximum Length: 50

  The time zone of the building.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is used to view all associated contacts.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• FacilityCapacity: integer (int32)
  Title: Capacity

  The maximum capacity of the facility.
• FacilityCode: string
  Title: Facility

  Maximum Length: 20

  The unique alternate identifier for the facility.
• FacilityConflictFlag: boolean
  Title: Facility Conflict

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether this facility has a conflict between its meetings.
• FacilityDescription: string
  Title: Description

  Maximum Length: 1000

  The description of the facility.
• FacilityId: integer (int64)
  Title: Facility ID

  The unique identifier of the facility.
• FacilityRoomNumber: string
  Title: Room Number

  Maximum Length: 10

  The room number of the facility.
• FacilityStatus: string
  Title: Facility Status

  Read Only: true

  Maximum Length: 80

  The meaning of the facility type code.
• FacilityStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  A list of accepted values is defined in the lookup type ORA_HER_FACILITY_STATUS_CODE.
• FacilityType: string
  Title: Facility Type

  Read Only: true

  Maximum Length: 80

  The meaning of the facility type code.
• FacilityTypeCode: string
  Title: Facility Type

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_FACILITY_TYPE_CODE.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• locations: array Locations
  Title: Locations

  The locations resource shows all associated locations.

{
    "type":"object",
    "properties":{
        "FacilityTypeCode":{
            "title":"Facility Type",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_FACILITY_TYPE_CODE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_FACILITY_STATUS_CODE.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "assignments":{
            "title":"Drop Scheme Settings Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/academicFacilities-assignments-item-response"
            }
        },
        "BuildingName":{
            "title":"Building Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the building.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingTimeZoneCode":{
            "title":"Building Time Zone Code",
            "maxLength":"50",
            "type":"string",
            "description":"The time zone of the building.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityCode":{
            "title":"Facility",
            "maxLength":"20",
            "type":"string",
            "description":"The unique alternate identifier for the facility.",
            "nullable":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":"10",
            "type":"string",
            "description":"The room number of the facility.",
            "nullable":false,
            "x-queryable":true
        },
        "BuildingCode":{
            "title":"Code",
            "maxLength":"6",
            "type":"string",
            "description":"The unique alternate identifier of the building.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "Property":"Value"
            },
            "x-queryable":true
        },
        "BuildingStatus":{
            "title":"Building Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the building status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the facility.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BuildingStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_BUILDING_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "BuildingId":{
            "title":"Building",
            "type":"integer",
            "description":"The unique identifier of the building.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the building.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "blackoutDates":{
            "title":"Blackout Dates",
            "type":"array",
            "description":"The blackout dates resource is used to list the dates the facility is unavailable.",
            "items":{
                "$ref":"#/components/schemas/academicFacilities-blackoutDates-item-response"
            }
        },
        "FacilityCapacity":{
            "title":"Capacity",
            "type":"integer",
            "description":"The maximum capacity of the facility.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "FacilityStatus":{
            "title":"Facility Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the facility type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityId":{
            "title":"Facility ID",
            "type":"integer",
            "description":"The unique identifier of the facility.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FacilityConflictFlag":{
            "title":"Facility Conflict",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this facility has a conflict between its meetings.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "BuildingTimeZone":{
            "title":"Building Time Zone",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the time zone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"The locations resource shows all associated locations.",
            "items":{
                "$ref":"#/components/schemas/academicFacilities-locations-item-response"
            }
        },
        "FacilityType":{
            "title":"Facility Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the facility type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is used to view all associated contacts.",
            "items":{
                "$ref":"#/components/schemas/academicFacilities-contacts-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Drop Scheme Settings Assignments

Type: array

Title: Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object academicFacilities-assignments-item-response

{
    "title":"Drop Scheme Settings Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/academicFacilities-assignments-item-response"
    }
}

Nested Schema : Blackout Dates

Type: array

Title: Blackout Dates

The blackout dates resource is used to list the dates the facility is unavailable.

Show Source

• Array of: object academicFacilities-blackoutDates-item-response

{
    "title":"Blackout Dates",
    "type":"array",
    "description":"The blackout dates resource is used to list the dates the facility is unavailable.",
    "items":{
        "$ref":"#/components/schemas/academicFacilities-blackoutDates-item-response"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is used to view all associated contacts.

Show Source

• Array of: object academicFacilities-contacts-item-response

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is used to view all associated contacts.",
    "items":{
        "$ref":"#/components/schemas/academicFacilities-contacts-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 : Locations

Type: array

Title: Locations

The locations resource shows all associated locations.

Show Source

• Array of: object academicFacilities-locations-item-response

{
    "title":"Locations",
    "type":"array",
    "description":"The locations resource shows all associated locations.",
    "items":{
        "$ref":"#/components/schemas/academicFacilities-locations-item-response"
    }
}

Nested Schema : academicFacilities-assignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityStatusCode: string
  Title: Entity Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the entity. This controls the availability of the entity for assignments to settings.
• AssignedEntityStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the entity.
• AssignedEntitySubTypeCode: string
  Title: Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssignedEntitySubTypeMeaning: string
  Title: Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodMeaning: string
  Title: Assignment Method

  Read Only: true

  Maximum Length: 80

  The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentMethodTypeCode: string
  Title: Assignment Method Code

  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• RelatedEntityCode: string
  Title: Related Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the related entity.
• RelatedEntityId: integer (int64)
  Title: Related Entity ID

  The unique identifier of the related entity.
• RelatedEntityName: string
  Title: Related Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the related entity.
• RelatedEntityTypeCode: string
  Title: Related Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• RelatedEntityTypeMeaning: string
  Title: Related Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the related entity.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeMeaning":{
            "title":"Related Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the related entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodTypeCode":{
            "title":"Assignment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeCode":{
            "title":"Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityStatusCode":{
            "title":"Entity Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the entity. This controls the availability of the entity for assignments to settings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeCode":{
            "title":"Related Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RelatedEntityId":{
            "title":"Related Entity ID",
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignmentMethodMeaning":{
            "title":"Assignment Method",
            "maxLength":"80",
            "type":"string",
            "description":"The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityStatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedEntityCode":{
            "title":"Related Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityName":{
            "title":"Related Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : 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 : academicFacilities-blackoutDates-item-response

Type: object

Show Source

• BlackoutId: integer (int64)
  Title: Blackout ID

  The unique identifier of the blackout record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• EndDate: string (date)
  Title: To

  The end or expiration date of the blackout date record
• EndTime: string (date-time)
  Title: End Time

  The end or expiration time of the blackout date record.
• FridayFlag: boolean
  Title: Friday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Fridays.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• MondayFlag: boolean
  Title: Monday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Mondays.
• SaturdayFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Saturdays.
• StartDate: string (date)
  Title: From

  The start date of the blackout date record.
• StartTime: string (date-time)
  Title: Start Time

  The start time of the blackout date record.
• SundayFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Sundays.
• ThursdayFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Thursdays.
• TuesdayFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Tuesdays.
• WednesdayFlag: boolean
  Title: Wednesday

  Maximum Length: 1

  Default Value: false

  The blackout schedule is active on Wednesdays.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FridayFlag":{
            "title":"Friday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Fridays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The end or expiration time of the blackout date record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ThursdayFlag":{
            "title":"Thursday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Thursdays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The start time of the blackout date record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "WednesdayFlag":{
            "title":"Wednesday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Wednesdays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SundayFlag":{
            "title":"Sunday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Sundays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"To",
            "type":"string",
            "description":"The end or expiration date of the blackout date record",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"From",
            "type":"string",
            "description":"The start date of the blackout date record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SaturdayFlag":{
            "title":"Saturday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Saturdays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BlackoutId":{
            "title":"Blackout ID",
            "type":"integer",
            "description":"The unique identifier of the blackout record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MondayFlag":{
            "title":"Monday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Mondays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TuesdayFlag":{
            "title":"Tuesday",
            "maxLength":"1",
            "type":"boolean",
            "description":"The blackout schedule is active on Tuesdays.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : academicFacilities-contacts-item-response

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: End Date

  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  Title: Start Date

  The start date of the contact association.
• ContactAssociationId: integer (int64)
  Title: Contact Association ID

  Read Only: true

  The unique identifier for the contact association record.
• ContactPartyId: integer (int64)
  Title: Party ID

  The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
• ContactStatusCode: string
  Title: Contact Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The contact status code for this contact.
• ContactStatusMeaning: string
  Title: Contact Status

  Read Only: true

  Maximum Length: 80

  The meaning of the contact status code for this contact.
• ContactTypeCode: string
  Title: Contact Type Code

  Maximum Length: 30

  Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• ContactTypeMeaning: string
  Title: Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• DefaultContactTypeCode: string
  Title: Default Contact Type Code

  Read Only: true

  Maximum Length: 30

  The default contact type code for this contact.
• DefaultContactTypeMeaning: string
  Title: Default Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the default contact type code for this contact.
• DefaultDepartment: string
  Title: Default Department

  Read Only: true

  Maximum Length: 100

  The default job title for this contact.
• DefaultJobTitle: string
  Title: Default Job Title

  Read Only: true

  Maximum Length: 100

  The default department of this contact.
• Department: string
  Title: Department

  Maximum Length: 100

  The name of the department that the contact belongs to.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person.
• FullName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the associated contact.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the person.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• MiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The middle name of the person.
• NameSuffix: string
  Title: Suffix

  Read Only: true

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• PhoneAreaCode: string
  Title: Area Code

  Read Only: true

  Maximum Length: 20

  The area code within a country.
• PhoneCountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneNumber: string
  Title: Phone Number

  Read Only: true

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PreferredFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of a person.
• PreferredFullName: string
  Title: Preferred Name

  Read Only: true

  Maximum Length: 360

  The preferred first and last name of the person displayed as a single string.
• PreferredLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The preferred last name of a person.
• PreferredMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The preferred middle name of a person.
• PreferredNameSuffix: string
  Title: Name Suffix

  Read Only: true

  Maximum Length: 30

  The preferred name suffix of the person such as junior or senior.
• PreferredNameTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The preferred name title of the person such as Mr or Mrs.
• PrimaryContactFlag: boolean
  Title: Primary Contact

  Maximum Length: 1

  Indicates that this person should be the primary contact.
• Title: string
  Title: Prefix

  Read Only: true

  Maximum Length: 60

  The name title or prefix of the person such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Contact Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactStatusCode":{
            "title":"Contact Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The contact status code for this contact.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DefaultJobTitle":{
            "title":"Default Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The default department of this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreferredNameTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The preferred name title of the person such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultDepartment":{
            "title":"Default Department",
            "maxLength":"100",
            "type":"string",
            "description":"The default job title for this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DefaultContactTypeCode":{
            "title":"Default Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The default contact type code for this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Prefix",
            "maxLength":"60",
            "type":"string",
            "description":"The name title or prefix of the person such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PreferredLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultContactTypeMeaning":{
            "title":"Default Contact Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the default contact type code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactStatusMeaning":{
            "title":"Contact Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the contact status code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactAssociationId":{
            "title":"Contact Association ID",
            "type":"integer",
            "description":"The unique identifier for the contact association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the contact association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PreferredFullName":{
            "title":"Preferred Name",
            "maxLength":"360",
            "type":"string",
            "description":"The preferred first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The preferred middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : academicFacilities-locations-item-response

Type: object

Show Source

• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddressFour: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The fourth line for the address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Read Only: true

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines, used in Japan.
• AddressOne: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line for the address.
• AddressThree: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The third line for the address.
• AddressTwo: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line for the address.
• AddressUseTypeCode: string
  Title: Address Use Type Code

  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: Address Use Type

  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.
• AssociationEndDate: string (date)
  Title: End Date

  The end date of the location site association.
• AssociationStartDate: string (date)
  Title: Start Date

  The start date of the location site association.
• Building: string
  Title: Building

  Read Only: true

  Maximum Length: 240

  The building name or number at a given address.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city for the address.
• CountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 2

  The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county of the address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• FloorNumber: string
  Title: Floor Number

  Read Only: true

  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

  Read Only: true

  Maximum Length: 30

  The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• HouseTypeMeaning: string
  Title: House Type

  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)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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)
  Title: Location Association ID

  Read Only: true

  The unique identifier for the location association identifier.
• LocationDirections: string
  Title: Location Directions

  Read Only: true

  Maximum Length: 640

  The directions to the location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier of the location.
• LocationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 100

  The name of the location.
• LocationStatusCode: string
  Title: Location Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the location. This controls the availability of the location for assignments.
• LocationStatusMeaning: string
  Title: Location Status

  Read Only: true

  Maximum Length: 80

  The status of the location.
• Position: string
  Title: Position

  Read Only: true

  Maximum Length: 50

  The primary direction such as North or East that's used to access the location.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the address.
• PostalPlusFourCode: string
  Title: Postal Code Extension

  Read Only: true

  Maximum Length: 20

  The four digit extension to the United States postal code.
• PreferredAddressFlag: boolean
  Title: Preferred Address

  Maximum Length: 1

  Indicates the preferred address. The default value is: false.
• Province: string
  Title: Province Code

  Read Only: true

  Maximum Length: 60

  The province of the address.
• StateCode: string
  Title: State Code

  Read Only: true

  Maximum Length: 60

  The state of the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PreferredAddressFlag":{
            "title":"Preferred Address",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false,
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "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,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Address Use Type Code",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "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 lines, used in Japan.",
            "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"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"The country code from the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationStatusMeaning":{
            "title":"Location Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Address Use Type",
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "title":"House Type",
            "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
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "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
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationStatusCode":{
            "title":"Location Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the location. This controls the availability of the location for assignments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province Code",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssociationEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the location site association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationAssociationId":{
            "title":"Location Association ID",
            "type":"integer",
            "description":"The unique identifier for the location association identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false,
            "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,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Back to Top