Create an external organization
post
/fscmRestApi/resources/11.13.18.05/externalOrganizations
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if the external organization is active or inactive. -
addresses: array
Addresses
Title:
Addresses
The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization. -
contacts: array
Contacts
Title:
Contacts
The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization. -
externalCourses: array
External Courses
Title:
External Courses
The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization. -
externalSubjects: array
External Subjects
Title:
External Subjects
The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization. -
identifiers: array
Identifiers
Title:
Identifiers
The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies. -
nameHistory: array
External Organization History Names
Title:
External Organization History Names
The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization. -
OrganizationName(required): string
Title:
Organization Name
Maximum Length:360
The name of the external organization. -
OrganizationTypeCode: string
Title:
Organization Type Code
Maximum Length:30
The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE. -
PartyId(required): integer
(int64)
Title:
Party ID
The unique identifier for the external organization. -
SchoolTypeCode: string
Maximum Length:
30
The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.
Show Source
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.
Show Source
Nested Schema : External Courses
Type:
array
Title:
External Courses
The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.
Show Source
Nested Schema : External Subjects
Type:
array
Title:
External Subjects
The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.
Show Source
Nested Schema : Identifiers
Type:
array
Title:
Identifiers
The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.
Show Source
Nested Schema : External Organization History Names
Type:
array
Title:
External Organization History Names
The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.
Show Source
Nested Schema : externalOrganizations-addresses-item-post-request
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Maximum Length:150
The fifth additional address element. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Maximum Length:150
The fourth additional address element. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Maximum Length:150
The first additional address element. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Maximum Length:150
The third additional address element. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Maximum Length:150
The second additional address element. -
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 lines, 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
Title:
Purpose
Maximum Length:30
The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The name of the city mentioned in the address. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
EndDate: string
(date)
Title:
To Date
The end date of the address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the building in the address. -
HouseTypeCode: string
Title:
House Type
Maximum Length:30
The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The location directions of the address. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name for the location in the address. -
Position: string
Title:
Position
Maximum Length:50
The position of the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Maximum Length:20
The postal plus four code of the address. -
PreferredFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is a preferred address or not. -
Province: string
Title:
Province
Maximum Length:60
The province code of the address. -
StartDate: string
(date)
Title:
From Date
The start date of the address. -
State: string
Title:
State
Maximum Length:60
The state code of the address.
Nested Schema : externalOrganizations-contacts-item-post-request
Type:
Show Source
object
-
ContactId: integer
(int64)
The unique identifier for the contact.
-
ContactTitleCode: string
Title:
Prefix
Maximum Length:30
The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTypeCode: string
Maximum Length:
30
The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
60
The department of the contact. -
EmailAddress: string
Maximum Length:
1000
The email for the contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the contact. -
FullName: string
Title:
Name
Maximum Length:450
The full name of the contact. -
JobTitle: string
Maximum Length:
100
The job title of the contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the contact. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates if this is a primary contact.
Nested Schema : externalOrganizations-externalCourses-item-post-request
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the subject is active or inactive. -
CourseIdentifier: string
Maximum Length:
50
Alternate unique identifier for the course defined for an external organization. -
CourseLevelCode: string
Maximum Length:
30
The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseName: string
Maximum Length:
50
The name for the external course. -
CourseTypeCode: string
Maximum Length:
30
The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseUnits: number
The number of units earned in the course.
-
Description: string
Description for the external course.
-
EffectiveEndDate: string
(date)
Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
-
ExternalAcademicLevelCode: string
Maximum Length:
30
The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalCourseId: integer
(int64)
External subject unique identifier.
-
ExternalCourseRowId: integer
(int64)
External subject unique identifier.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
OrganizationId: integer
(int64)
External organization unique identifier that owns this subject.
Nested Schema : externalOrganizations-externalSubjects-item-post-request
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the course is active or inactive. -
Description: string
Description for the external subject.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
SubjectCode: string
Maximum Length:
50
Alternate unique identifier for the external subject defined for an external organization. -
SubjectName: string
Maximum Length:
50
The name for the external subject.
Nested Schema : externalOrganizations-identifiers-item-post-request
Type:
Show Source
object
-
OrganizationIdentifierCode: string
Title:
Identifier Type
Maximum Length:30
The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE. -
OrganizationIdentifierValue: string
Title:
Identifier
Maximum Length:50
The external organization identifier value issued by an external agency.
Nested Schema : externalOrganizations-nameHistory-item-post-request
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Indicates the date at the end of the date range within which the row is effective.
-
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the external organization. -
PartyId: integer
(int64)
The unique identifier for the external organization.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : externalOrganizations-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if the external organization is active or inactive. -
addresses: array
Addresses
Title:
Addresses
The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization. -
contacts: array
Contacts
Title:
Contacts
The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization. -
externalCourses: array
External Courses
Title:
External Courses
The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization. -
externalSubjects: array
External Subjects
Title:
External Subjects
The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization. -
identifiers: array
Identifiers
Title:
Identifiers
The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nameHistory: array
External Organization History Names
Title:
External Organization History Names
The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the external organization. -
OrganizationType: string
Title:
Organization Type
Read Only:true
Maximum Length:80
The type of the external organization, for example school or business. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE. -
OrganizationTypeCode: string
Title:
Organization Type Code
Maximum Length:30
The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier for the external organization. -
SchoolType: string
Read Only:
true
Maximum Length:80
The type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE. -
SchoolTypeCode: string
Maximum Length:
30
The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.
Show Source
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.
Show Source
Nested Schema : External Courses
Type:
array
Title:
External Courses
The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.
Show Source
Nested Schema : External Subjects
Type:
array
Title:
External Subjects
The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.
Show Source
Nested Schema : Identifiers
Type:
array
Title:
Identifiers
The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : External Organization History Names
Type:
array
Title:
External Organization History Names
The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.
Show Source
Nested Schema : externalOrganizations-addresses-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Maximum Length:150
The fifth additional address element. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Maximum Length:150
The fourth additional address element. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Maximum Length:150
The first additional address element. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Maximum Length:150
The third additional address element. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Maximum Length:150
The second additional address element. -
AddressFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The Phonetic or Kana representation of the Kanji address lines, 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
Title:
Purpose
Maximum Length:30
The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
AddressUseTypeMeaning: string
Read Only:
true
Maximum Length:80
The use type meaning of the address, for example, home or business. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The name of the city mentioned in the address. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
EndDate: string
(date)
Title:
To Date
The end date of the address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the building in the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline address. -
HouseTypeCode: string
Title:
House Type
Maximum Length:30
The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Read Only:
true
Maximum Length:80
The house type meaning of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The location directions of the address. -
LocationId: integer
(int64)
Title:
Location ID
Read Only:true
The unique identifier for the location in the address. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name for the location in the address. -
Position: string
Title:
Position
Maximum Length:50
The position of the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Maximum Length:20
The postal plus four code of the address. -
PreferredFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is a preferred address or not. -
Province: string
Title:
Province
Maximum Length:60
The province code of the address. -
StartDate: string
(date)
Title:
From Date
The start date of the address. -
State: string
Title:
State
Maximum Length:60
The state code of the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : externalOrganizations-contacts-item-response
Type:
Show Source
object
-
ContactId: integer
(int64)
The unique identifier for the contact.
-
ContactTitleCode: string
Title:
Prefix
Maximum Length:30
The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTitleMeaning: string
Read Only:
true
Maximum Length:80
The contact title meaning of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTypeCode: string
Maximum Length:
30
The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The contact type meaning of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
60
The department of the contact. -
EmailAddress: string
Maximum Length:
1000
The email for the contact. -
EndDate: string
(date)
Read Only:
true
The end date of the contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the contact. -
FullName: string
Title:
Name
Maximum Length:450
The full name of the contact. -
JobTitle: string
Maximum Length:
100
The job title of the contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates if this is a primary contact. -
StartDate: string
(date)
Read Only:
true
The start date of the contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : externalOrganizations-externalCourses-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the subject is active or inactive. -
CourseIdentifier: string
Maximum Length:
50
Alternate unique identifier for the course defined for an external organization. -
CourseLevelCode: string
Maximum Length:
30
The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseLevelMeaning: string
Read Only:
true
Maximum Length:80
The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseName: string
Maximum Length:
50
The name for the external course. -
CourseTypeCode: string
Maximum Length:
30
The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseTypeMeaning: string
Read Only:
true
Maximum Length:80
The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseUnits: number
The number of units earned in the course.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the row for the identifier. -
Description: string
Description for the external course.
-
EffectiveEndDate: string
(date)
Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
-
ExternalAcademicLevelCode: string
Maximum Length:
30
The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalAcademicLevelMeaning: string
Read Only:
true
Maximum Length:80
The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalCourseId: integer
(int64)
External subject unique identifier.
-
ExternalCourseRowId: integer
(int64)
External subject unique identifier.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
External organization unique identifier that owns this subject.
-
SubjectCode: string
Read Only:
true
Maximum Length:50
The external subject defined for an external organization associated with the external course.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : externalOrganizations-externalSubjects-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the course is active or inactive. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the row for the identifier. -
Description: string
Description for the external subject.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row for the identifier was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row for the identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubjectCode: string
Maximum Length:
50
Alternate unique identifier for the external subject defined for an external organization. -
SubjectName: string
Maximum Length:
50
The name for the external subject.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : externalOrganizations-identifiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the row for the identifier. -
EndDate: string
(date)
Read Only:
true
The end date of the identifier. -
IdentifierId: integer
(int64)
Read Only:
true
The identifier for the external organization identifier value. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row for the identifier was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row for the identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationIdentifierCode: string
Title:
Identifier Type
Maximum Length:30
The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE. -
OrganizationIdentifierMeaning: string
Read Only:
true
Maximum Length:80
The external organization identifier meaning. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE. -
OrganizationIdentifierValue: string
Title:
Identifier
Maximum Length:50
The external organization identifier value issued by an external agency. -
StartDate: string
(date)
Read Only:
true
The start date of the identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : externalOrganizations-nameHistory-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of the creation of the row for the identifier. -
EffectiveEndDate: string
(date)
Indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Indicates the date at the end of the date range within which the row is effective.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the external organization. -
PartyId: integer
(int64)
The unique identifier for the external organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- HerLookupVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: SchoolTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- HeyLookupVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_ORG_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- addresses
-
Parameters:
- PartyId:
$request.path.PartyId
The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization. - PartyId:
- contacts
-
Parameters:
- PartyId:
$request.path.PartyId
The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization. - PartyId:
- externalCourses
-
Parameters:
- PartyId:
$request.path.PartyId
The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization. - PartyId:
- externalSubjects
-
Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjectsParameters:
- PartyId:
$request.path.PartyId
The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization. - PartyId:
- identifiers
-
Parameters:
- PartyId:
$request.path.PartyId
The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies. - PartyId:
- nameHistory
-
Parameters:
- PartyId:
$request.path.PartyId
The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization. - PartyId: