Create an extracurricular activity
post
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities
Request
Path Parameters
-
ApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Academic level code when the activity occurred. -
ActivityDescription: string
Title:
Activity Description
Maximum Length:1000
Description of the extracurricular activity. -
ActivityTypeCode: string
Title:
Activity Type Code
Maximum Length:30
Activity type code of the extracurricular activity. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an extracurricular activity. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an extracurricular activity. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an extracurricular activity. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an extracurricular activity. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
EndDate: string
(date)
Title:
End Date
Date when the extracurricular activity ended. -
HoursPERWeek: integer
(int32)
Title:
Hours per Week
Number of hours per week that student participates in the activity. -
InterestedInPursuingCode: string
Title:
Interested in Pursuing Code
Maximum Length:30
Indicates if student is interested in pursuing the activity at the institution. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization where the activity occurred. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an extracurricular activity. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an extracurricular activity. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an extracurricular activity. -
PositionHeld: string
Title:
Position Held
Maximum Length:100
Position held for the extracurricular activity, such as captain or treasurer. -
StartDate: string
(date)
Title:
Start Date
Date when the extracurricular activity started. -
WeeksPERYear: integer
(int32)
Title:
Weeks per Year
Number of weeks per year that student participates in the activity.
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 : admissionApplications-extracurricularActivities-item-response
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Academic level code when the activity occurred. -
AcademicLevelCodeMeaning: string
Title:
Academic Level
Read Only:true
Maximum Length:80
Meaning of academic level code. -
ActivityDescription: string
Title:
Activity Description
Maximum Length:1000
Description of the extracurricular activity. -
ActivityTypeCode: string
Title:
Activity Type Code
Maximum Length:30
Activity type code of the extracurricular activity. -
ActivityTypeCodeMeaning: string
Title:
Activity Type
Read Only:true
Maximum Length:80
Meaning of activity type code. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an extracurricular activity. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an extracurricular activity. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an extracurricular activity. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an extracurricular activity. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
EndDate: string
(date)
Title:
End Date
Date when the extracurricular activity ended. -
ExtracurricularTransactionId: integer
(int64)
Title:
Extracurricular Transaction ID
Read Only:true
Extracurricular activity transaction unique identifier. -
HoursPERWeek: integer
(int32)
Title:
Hours per Week
Number of hours per week that student participates in the activity. -
InterestedInPursuingCode: string
Title:
Interested in Pursuing Code
Maximum Length:30
Indicates if student is interested in pursuing the activity at the institution. -
InterestedInPursuingCodeMeaning: string
Title:
Interested in Pursuing
Read Only:true
Maximum Length:80
Meaning of pursuing code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:100
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization where the activity occurred. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an extracurricular activity. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an extracurricular activity. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an extracurricular activity. -
PositionHeld: string
Title:
Position Held
Maximum Length:100
Position held for the extracurricular activity, such as captain or treasurer. -
StartDate: string
(date)
Title:
Start Date
Date when the extracurricular activity started. -
WeeksPERYear: integer
(int32)
Title:
Weeks per Year
Number of weeks per year that student participates in the activity.
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.
Links
- academicLevelCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_EXTRACURR_ACAD_LEVEL%2CLookupCode%3D{AcademicLevelCode}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- activityTypeCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_EXTRACURR_ACTY_TYPE%2CLookupCode%3D{ActivityTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: ActivityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- interestedInPursuingCodeLookupsLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_EXTRACURR_INTRST_PURS%2CLookupCode%3D{InterestedInPursuingCode}
The following properties are defined on the LOV link relation:- Source Attribute: InterestedInPursuingCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: OrganizationPartyId; Target Attribute: PartyId
- Display Attribute: OrganizationName
- phoneCountryCodesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName