Get a project contact
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}
Request
Path Parameters
-
ContactKey: integer
The unique identifier for a project contact.
-
publicSectorProjectsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and ProjectCode ---for the Project Lists resource and used to uniquely identify an instance of Project Lists. The client should not generate the hash key value. Instead, the client should query on the Project Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Lists.
For example: publicSectorProjects?q=AgencyId=<value1>;ProjectCode=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjects-ProjectContact-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
City(optional):
string
Title:
City
Maximum Length:60
The city of the project contact address. -
ContactBizPartyId(optional):
integer(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project contact.
-
ContactId(optional):
integer(int64)
The unique identifier for the project contact.
-
ContactKey(optional):
integer(int64)
The unique identifier for a project contact.
-
ContactPartyId(optional):
integer(int64)
The party ID of the project contact.
-
ContactProfileId(optional):
integer(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
The type of contact. -
Country(optional):
string
Title:
Country
Maximum Length:3
The country of the project contact address. -
County(optional):
string
Title:
County
Maximum Length:60
The county of the project contact address. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the project contact. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the project contact was created. -
EmailAddress(optional):
string
Title:
Email
Maximum Length:320
The email address of the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last updated the project contact. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date when the project contact was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
OrganizationName(optional):
string
Title:
Organization Name
Maximum Length:360
The name of the organization of the project contact. -
PersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of the project contact. -
PersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of the project contact. -
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The middle name of the project contact. -
PersonName(optional):
string
Title:
Name
Maximum Length:450
The full name of the project contact. -
PersonNameSuffix(optional):
string
Maximum Length:
30
The name suffix of the project contact. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle(optional):
string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode(optional):
string
Maximum Length:
10
The area code of the contact phone number. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The country code of the contact phone number. -
PhoneExtension(optional):
string
Maximum Length:
20
The extension of the contact phone number. -
PhoneNumber(optional):
string
Maximum Length:
40
The phone number of the contact. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code of the project contact address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal plus four code of the project contact address. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. The default value is N. -
ProjectCode(optional):
string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province of the project contact address. -
State(optional):
string
Title:
State
Maximum Length:60
The state of the project contact address.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.