Update a contact association
patch
/fscmRestApi/resources/11.13.18.05/academicFacilities/{FacilityId}/child/contacts/{ContactAssociationId}
Request
Path Parameters
-
ContactAssociationId(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=
-
FacilityId(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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the contact association.
-
AssociationStartDate: string
(date)
The start date of the contact association.
-
ContactPartyId: integer
(int64)
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
-
ContactTypeCode: string
Maximum Length:
30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
100
The name of the department that the contact belongs to. -
JobTitle: string
Maximum Length:
100
The job title of the associated contact. -
PrimaryContactFlag: boolean
Maximum Length:
1
Indicates that this person should be the primary contact.
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 : academicFacilities-contacts-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the contact association.
-
AssociationStartDate: string
(date)
The start date of the contact association.
-
ContactAssociationId: integer
(int64)
Read Only:
true
The unique identifier for the contact association record. -
ContactPartyId: integer
(int64)
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
-
ContactStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_ACTIVE
The contact status code for this contact. -
ContactStatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact status code for this contact. -
ContactTypeCode: string
Maximum Length:
30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
DefaultContactTypeCode: string
Read Only:
true
Maximum Length:30
The default contact type code for this contact. -
DefaultContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the default contact type code for this contact. -
DefaultDepartment: string
Read Only:
true
Maximum Length:100
The default job title for this contact. -
DefaultJobTitle: string
Read Only:
true
Maximum Length:100
The default department of this contact. -
Department: string
Maximum Length:
100
The name of the department that the contact belongs to. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the contact. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The first and last name of the person displayed as a single string. -
JobTitle: string
Maximum Length:
100
The job title of the associated contact. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
NameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The name suffix of the person such as junior or senior. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
The area code within a country. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PreferredFirstName: string
Read Only:
true
Maximum Length:150
The preferred first name of a person. -
PreferredFullName: string
Read Only:
true
Maximum Length:360
The preferred first and last name of the person displayed as a single string. -
PreferredLastName: string
Read Only:
true
Maximum Length:150
The preferred last name of a person. -
PreferredMiddleName: string
Read Only:
true
Maximum Length:60
The preferred middle name of a person. -
PreferredNameSuffix: string
Read Only:
true
Maximum Length:30
The preferred name suffix of the person such as junior or senior. -
PreferredNameTitle: string
Read Only:
true
Maximum Length:60
The preferred name title of the person such as Mr or Mrs. -
PrimaryContactFlag: boolean
Maximum Length:
1
Indicates that this person should be the primary contact. -
Title: string
Title:
Title
Read Only:true
Maximum Length:60
The name title or prefix of the person such as Mr or Mrs.
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
- ContactStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{ContactStatusCode}%2CLookupType%3DORA_HER_CONTACT_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: ContactStatusCode; Target Attribute: LookupType
- Display Attribute: Meaning
- finder:
- ContactTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{ContactTypeCode}%2CLookupType%3DORA_HEY_ORG_CON_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ContactTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DefaultContactTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{DefaultContactTypeCode}%2CLookupType%3DORA_HEY_ORG_CON_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: DefaultContactTypeCode; Target Attribute: LookupType
- Display Attribute: Meaning
- finder:
- PhoneCountryCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName