openapi: 3.2.0 info: contact: name: Lavanya Appa email: LAVANYA.APPA@ADP.COM description: 'The Talent Profile Educational Degree Application Programming Interfaces (APIs) support the management of an associate''s educational degrees.These can be used to track your employees'' educational development, including the following: Learning institutions Education levels Degrees Start and end dates Credit types Areas of study GPA (Grade Point Average), if allowed by the employee''s jurisdiction Honorary degrees You can also set up custom fields for educational degrees information in…' title: Associate Educational Degrees Educational Degree Add API version: 2.0.3 x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/talent/associate-educational-degrees/v2/associate-educational-degrees-swagger_v2-merged.json x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn) x-apievangelist-resource-path: talent/associate-educational-degrees/v2/associate-educational-degrees servers: - url: https://api.adp.com description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens' - url: https://api.eu.adp.com description: ADP European API gateway - url: https://uat-api.adp.com description: ADP UAT / sandbox gateway tags: - name: Educational Degree Add description: Educational degree add management events. paths: /events/talent/v1/associate.ksaoc.educational-degree.add: x-adpPathData: uriTranslationIndicator: false featureCode: workerKSAOCManagement functionCode: educationalDegreeManagement serviceCode: workerTalentManagement serviceCategoryCode: talent canonicalName: Educational Degree Add post: summary: Add Educational Degree x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobileESSWorkerKSAOC - MobilePSSWorkerKSAOC - MobileMSSWorkerKSAOC sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: talent/workerTalentManagement/workerKSAOCManagement/educationalDegreeManagement/educationalDegree.add operationCode: educationalDegree.add operationId: a84e1371-ede5-40c5-a775-24575aa2f828 roleCodes: - employee - practitioner - manager performAuthIndicator: true scenarios: - summary: Adding an educational degree with invalid currency code. name: 5. Adding an educational degree with invalid currency code. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Response of Adding an educational degree with invalid currency code. content: application/json: externalValue: ./examples/5._Adding_an_educational_degree_with_invalid_currency_code._Provide_Example_educationalDegree.add_200_47398.json description: Adding an educational degree with invalid currency code. content: application/json: externalValue: ./examples/5._Adding_an_educational_degree_with_invalid_currency_code._Provide_Example_educationalDegree.add_request_4592.json - summary: Adding an educational degree with invalid educational institution. name: 4. Adding an educational degree with invalid educational institution. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Response of Adding an educational degree with invalid educational institution. content: application/json: externalValue: ./examples/4._Adding_an_educational_degree_with_invalid_educational_institution._Provide_Example_educationalDegree.add_200_47397.json description: Adding an educational degree with invalid educational institution. content: application/json: externalValue: ./examples/4._Adding_an_educational_degree_with_invalid_educational_institution._Provide_Example_educationalDegree.add_request_4591.json - summary: Adding an educational degree with invalid major program code. name: 3. Adding an educational degree with invalid major program code. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Response of Adding an educational degree with invalid major program code. content: application/json: externalValue: ./examples/3._Adding_an_educational_degree_with_invalid_major_program_code._Provide_Example_educationalDegree.add_200_47396.json description: Adding an educational degree with invalid major program code. content: application/json: externalValue: ./examples/3._Adding_an_educational_degree_with_invalid_major_program_code._Provide_Example_educationalDegree.add_request_4590.json - summary: Adds a educational degree for an associate. name: 1. Adding a educational degree for an associate. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: response of Adding a educational degree for an associate. content: application/json: externalValue: ./examples/1._Adding_a_educational_degree_for_an_associate._Provide_Example_educationalDegree.add_200_47394.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: 'Adding an educational degree with a blank educational degree. "userMessage": { "messageTxt": "Degree/Achievement Level is required." }' content: application/json: externalValue: ./examples/1._Adding_a_educational_degree_for_an_associate._Provide_Example_educationalDegree.add_400_47400.json - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '400' description: 'Adding an educational degree with an existing Qualifications, Learning Institution, and Start Date combination. "userMessage": { "messageTxt": "A record with the same Qualifications, Learning Institution, and Start Date already exists and cannot be duplicated." }' content: application/json: externalValue: ./examples/1._Adding_a_educational_degree_for_an_associate._Provide_Example_educationalDegree.add_400_47399.json description: Adds a educational degree for an associate. content: application/json: externalValue: ./examples/1._Adding_a_educational_degree_for_an_associate._Provide_Example_educationalDegree.add_request_4588.json - summary: Adding an educational degree with invalid associateEducationalDegree. name: 2. Adding an educational degree with invalid associateEducationalDegree. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Response of Adding an educational degree with invalid associateEducationalDegree. content: application/json: externalValue: ./examples/2._Adding_an_educational_degree_with_invalid_associateEducationalDegree._Provide_Example_educationalDegree.add_200_47395.json description: Adding an educational degree with invalid associateEducationalDegree. content: application/json: externalValue: ./examples/2._Adding_an_educational_degree_with_invalid_associateEducationalDegree._Provide_Example_educationalDegree.add_request_4589.json visibilityCodes: - internal - external globalViewDevPortalIndicator: true requestBody: description: posted contents content: application/json: schema: $ref: ./schemas/events_talent.associate.ksaoc.educationalDegree.add_schema_v01_00_rev008.json multipart/*: {} required: true responses: '200': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: An associate's educational degree is added content: application/json: schema: $ref: ./schemas/events_talent.associate.ksaoc.educationalDegree.add_schema_v01_00_rev008.json '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' '412': $ref: '#/components/responses/412' '403': $ref: '#/components/responses/403' '503': $ref: '#/components/responses/503' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: An associate's educational degree is added operationId: a84e1371-ede5-40c5-a775-24575aa2f828 parameters: - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: G4O73G9Z62SL2NFM type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Acting-SessionID description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: en-US type: string in: header name: Accept-Language description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-AssociateOID description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ConsumerAppOID description: Identifier for the service consumer application. This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-PersonOID description: Contains the OID of the person that is the end user (i.e., actor). x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_serversessionid description: 'SiteMinder session ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA=' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal required: false - schema: default: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false tags: - Educational Degree Add /events/talent/v1/associate.ksaoc.educational-degree.add/meta: x-adpPathData: uriTranslationIndicator: false featureCode: workerKSAOCManagement functionCode: educationalDegreeManagement serviceCode: workerTalentManagement serviceCategoryCode: talent canonicalName: Educational Degree Add get: summary: Add Educational Degree Meta x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobileESSWorkerKSAOC - MobilePSSWorkerKSAOC - MobileMSSWorkerKSAOC sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: talent/workerTalentManagement/workerKSAOCManagement/educationalDegreeManagement/educationalDegree.add operationCode: educationalDegree.add operationId: 7734a0cb-d379-4aff-9d88-969a2730b73c roleCodes: - employee - practitioner - manager performAuthIndicator: true scenarios: - summary: Returns meta information. name: Returns meta information. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset sm_transactionid: unset ETag: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Returns an event metadata content: application/json: externalValue: ./examples/Returns_meta_information._Provide_Example_educationalDegree.add_200_47401.json description: Returns meta information. visibilityCodes: - internal - external globalViewDevPortalIndicator: true responses: '200': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Returns an event metadata content: application/json: schema: $ref: ./schemas/events_talent.associate.ksaoc.educationalDegree.add_meta_schema_v01_00_rev008.json '400': $ref: '#/components/responses/400' '412': $ref: '#/components/responses/412' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '304': $ref: '#/components/responses/304' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '503': $ref: '#/components/responses/503' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Returns an event metadata operationId: 7734a0cb-d379-4aff-9d88-969a2730b73c parameters: - schema: default: '' type: string in: header name: ADP-PersonOID description: Contains the OID of the person that is the end user (i.e., actor). x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Acting-SessionID description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: en-US type: string in: header name: Accept-Language description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-AssociateOID description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ConsumerAppOID description: Identifier for the service consumer application. This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_serversessionid description: 'SiteMinder session ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA=' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: G4O73G9Z62SL2NFM type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal required: false - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SOR description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $filter description: The OData $filter parameter MUST be used to specify the filter criterion. Please refer RESTful Web API Design Standard document for this query parameter specification details. x-adpParameterData: visibilityCodes: - internal required: false tags: - Educational Degree Add components: responses: '429': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Too Many Requests content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '406': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Not Acceptable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '403': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Forbidden content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '405': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Method Not Allowed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '500': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Internal Server Error content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '404': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Not Found content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '304': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Not Modified '400': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Bad Request content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '503': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Service Unavailable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '412': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Precondition Failed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '413': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal required: false description: Request Entity Too Large content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json x-adpSpecData: domain: Talent specId: 61e20429-e138-4017-b36a-4bffcdefb910 canonicalSpecId: f61e8d1f-b6c1-400e-aa22-a91245bd738a specStatusCode: publishing specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: associate-educational-degrees-swagger_v2-merged.json serviceProviderId: wfn resourcePath: talent/associate-educational-degrees/v2 libraryVersion: '' businessRules: - rule: R3.6 ruleTitle: An event which is being recorded includes the /data/eventContext and the /data/transform during the composition phase (i.e. recording of the event). visibilityCodes: - internal - rule: R3.1 ruleTitle: /data/input is optional. Input communicates data that is needed to complete recording the event instance. An example is a benefits.enroll event. The input communicates the benefitOfferings (the choices) that the user has to make which are communicated in the transform. visibilityCodes: - internal - rule: R5.0 ruleTitle: Meta returns the context rules for each data section visibilityCodes: - internal - rule: R3.0 ruleTitle: /data/schemaContext communicates the keys and properties that relate the event instance to a concrete concept (e.g. associate). visibilityCodes: - internal - rule: R6.0 ruleTitle: An event instance may be created by a System of record for a user to complete. This event instance will have a event.status.code=created visibilityCodes: - internal - rule: R2.1 ruleTitle: If the event is declared by an actor then the creationDateTime is the date time when the first call is made to the System of Record. visibilityCodes: - internal - rule: R5.1 ruleTitle: The only information that must be valued in the meta for the events header are the standard codelist references for priorityCode, eventStatusCode, and serviceCategoryCode visibilityCodes: - internal - rule: R11.1 ruleTitle: '''associateoid'' in the uri pattern should match the ''associateoid'' in the request header parameter' visibilityCodes: - internal - rule: R6.2 ruleTitle: An event instance which has been recorded has an event.status.code=complete visibilityCodes: - internal - rule: R3.5 ruleTitle: A complete event has /data/eventContext and /data/output visibilityCodes: - internal - rule: R3.4 ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results. visibilityCodes: - internal - rule: R2.4 ruleTitle: If there is no effective date from a business perspective then the effective date should be set equal to the record date time. visibilityCodes: - internal - rule: R2.2 ruleTitle: The recordDateTime is the date time which the event is recorded in the system of record with an event.status.code=complete visibilityCodes: - internal - rule: R0.1 ruleTitle: If request contains ADP-Act-As-OrgOID, ADP-Act-As-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-Act-As-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data. visibilityCodes: - internal - rule: R0.2 ruleTitle: If request contains ADP-On-Behalf-Of-OrgOID, ADP-On-Behalf-Of-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-On-Behalf-Of-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data. visibilityCodes: - internal - rule: R0.3 ruleTitle: 'For Act-As or On-Behalf-Of requests, header ''Cache-Control: no-store'' MUST be set to indicate on server or on UI the response object SHOULD not be cached' visibilityCodes: - internal - rule: R1.0 ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete visibilityCodes: - internal - rule: R8.2 ruleTitle: An event notification does not include the transform or meta objects. visibilityCodes: - internal - rule: R2.3 ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective visibilityCodes: - internal - rule: R3.3 ruleTitle: /data/output communicates the result of the event instance. visibilityCodes: - internal - rule: R6.1 ruleTitle: An event instance which is being “worked on” has an event.status.code=inprogress visibilityCodes: - internal - rule: R2.0 ruleTitle: creationDateTime is the date that the event is created. If a System of Record creates the event instance then it sets the creationDateTime. visibilityCodes: - internal - rule: R15.1 ruleTitle: 'An SOR may return an HTTP 503 when they are down for a scheduled maintenance or for an outage.If an SOR is planning a maintenance window then they should plan on having an end point available to return the 503 with a standard confirmMessage. The confirmMessage will contain a message stating the date and timeframe that the maintenance window is for.The SOR should return the Retry-After response-header field with the Date and Time when they expect the system to be available. E.g. § Retry-After: Fri, 31 Dec 1999 23:59:59 GMT This does not need to be handled dynamically. They can set the time that their maintenance window ends.' visibilityCodes: - internal - rule: R8.3 ruleTitle: 'A self link is included in the /data/links with 1 links item with the following 2 properties: rel=”self” href=”/events-notifications/{domain}/v1/{event-name}/{eventID}”' visibilityCodes: - internal - rule: R8.1 ruleTitle: An event notification includes the /data/eventContext and /data/output objects. visibilityCodes: - internal - rule: R4.0 ruleTitle: All envelope data is set by the System of Record (e.g. event.ID, creationDateTime, recordDateTime, event.status.code, etc… visibilityCodes: - internal - rule: R3.2 ruleTitle: /data/transform is only used during the recording of the event. The transform is the data that is provided by a user/machine to complete the recording of the event. visibilityCodes: - internal eventNotifications: - eventCode: educationalDegree.remove.eventNotify.subscribe example: href: TALENT_associate.ksaoc.educational-degree.remove_WFN-CG.json testCaseCollection: example: href: Talent-Education.postman_collection.json description: Talent Profile Educational Degrees Postman Collection publicationContext: products: - productId: hcm-offrg-wfn productName: workforce now marketplaceProductName: ADP Workforce Now® specCategoryCode: ''