Get all project contacts
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact
Request
Path Parameters
-
publicSectorProjectsUniqID(required): string
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 fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a project contact by the primary key criteria.
Finder Variables:- ContactKey; integer; The unique identifier for a project contact.
- simpleSearchFinder: Finds a project contact that matches the specified keyword.
Finder Variables:- value; string; The keyword used to find a project contact by person name, first address, email address, phone number, contact type, organization name, or primary flag value.
- PrimaryKey: Finds a project contact by the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address1; string; The first or main address.
- Address2; string; The second address, if present.
- Address3; string; The third address, if present.
- Address4; string; The fourth address, if present.
- AgencyId; integer; The unique identifier for a public sector agency.
- City; string; The city of the project contact address.
- ContactBizPartyId; integer; The party ID of the business associated with the project contact.
- ContactBizProfileId; integer; The unique identifier for the business profile of the project contact.
- ContactId; integer; The unique identifier for the project contact.
- ContactKey; integer; The unique identifier for a project contact.
- ContactPartyId; integer; The party ID of the project contact.
- ContactProfileId; integer; The unique identifier for the personal profile of the project contact.
- ContactType; string; The type of contact.
- Country; string; The country of the project contact address.
- County; string; The county of the project contact address.
- CreatedBy; string; The user who created the project contact.
- CreationDate; string; The date when the project contact was created.
- EmailAddress; string; The email address of the contact.
- LastUpdateDate; string; The date when the project contact was last updated.
- LastUpdatedBy; string; The user who last updated the project contact.
- OrganizationName; string; The name of the organization of the project contact.
- PersonFirstName; string; The first name of the project contact.
- PersonLastName; string; The last name of the project contact.
- PersonMiddleName; string; The middle name of the project contact.
- PersonName; string; The full name of the project contact.
- PersonNameSuffix; string; The name suffix of the project contact.
- PersonPreNameAdjunct; string; The prefix for the project contact name. For example, Dr., Professor, etc.
- PersonTitle; string; The title of the project contact.
- PhoneAreaCode; string; The area code of the contact phone number.
- PhoneCountryCode; string; The country code of the contact phone number.
- PhoneExtension; string; The extension of the contact phone number.
- PhoneNumber; string; The phone number of the contact.
- PostalCode; string; The postal code of the project contact address.
- PostalPlus4Code; string; The postal plus four code of the project contact address.
- PrimaryFlag; boolean; 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; string; The unique identifier for a project.
- Province; string; The province of the project contact address.
- State; string; The state of the project contact address.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorProjects-ProjectContact
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjects-ProjectContact-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
City: string
Title:
City
Maximum Length:60
The city of the project contact address. -
ContactBizPartyId: integer
(int64)
The party ID of the business associated with the project contact.
-
ContactBizProfileId: integer
(int64)
The unique identifier for the business profile of the project contact.
-
ContactId: integer
(int64)
The unique identifier for the project contact.
-
ContactKey: integer
(int64)
The unique identifier for a project contact.
-
ContactPartyId: integer
(int64)
The party ID of the project contact.
-
ContactProfileId: integer
(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType: string
Title:
Contact Type
Maximum Length:30
The type of contact. -
ContactTypeName: string
Title:
Contact Type
Read Only:true
Maximum Length:255
The name of the project contact type. -
Country: string
Title:
Country
Maximum Length:3
The country of the project contact address. -
County: string
Title:
County
Maximum Length:60
The county of the project contact address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the project contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project contact was created. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the project contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the project contact. -
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 organization of the project contact. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the project contact. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the project contact. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the project contact. -
PersonName: string
Title:
Name
Maximum Length:450
The full name of the project contact. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the project contact. -
PersonPreNameAdjunct: string
Maximum Length:
30
The prefix for the project contact name. For example, Dr., Professor, etc. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact phone number. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact phone number. -
PhoneExtension: string
Maximum Length:
20
The extension of the contact phone number. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the project contact address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal plus four code of the project contact address. -
PrimaryFlag: boolean
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: string
Title:
Project ID
Maximum Length:30
The unique identifier for a project. -
Province: string
Title:
Province
Maximum Length:60
The province of the project contact address. -
State: string
Title:
State
Maximum Length:60
The state of the project contact 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.