Create a set of project contacts
post
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
Request
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
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or the main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if applicable. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
City: string
Title:
City
Maximum Length:60
The city of the project contact. -
ContactBizPartyId: integer
(int64)
The identifier of the business that is 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 of the project contact.
-
ContactPartyId: integer
(int64)
The identifier 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. -
Country: string
Title:
Country
Maximum Length:3
The name of the country of the contact. -
County: string
Title:
County
Maximum Length:60
The name of the county of the contact. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the contact. -
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 name of the project contact. -
PersonNameSuffix: string
Maximum Length:
30
The suffix to the name of the project contact. -
PersonPreNameAdjunct: string
Maximum Length:
30
The person pre name of the adjunct. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode: string
Maximum Length:
10
The phone area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The phone country code of the contact. -
PhoneExtension: string
Maximum Length:
20
The phone extension of the contact. -
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. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code of the contact. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates if the current project contact is the primary contact. The value 'Y' indicates that the project contact is the primary contact and the value 'N' indicates that the contact is not the primary contact. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province of the project contact. -
State: string
Title:
State
Maximum Length:60
The name of the state of the project 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 : publicSectorProjectContacts-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or the main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line, if applicable. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line, if applicable. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line, if applicable. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
City: string
Title:
City
Maximum Length:60
The city of the project contact. -
ContactBizPartyId: integer
(int64)
The identifier of the business that is 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 of the project contact.
-
ContactPartyId: integer
(int64)
The identifier 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 contact type of the project contact. -
Country: string
Title:
Country
Maximum Length:3
The name of the country of the contact. -
County: string
Title:
County
Maximum Length:60
The name of the county of the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of 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 name of the user who last updated the project contact. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the project contact was last updated. -
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 name of the project contact. -
PersonNameSuffix: string
Maximum Length:
30
The suffix to the name of the project contact. -
PersonPreNameAdjunct: string
Maximum Length:
30
The person pre name of the adjunct. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the project contact. -
PhoneAreaCode: string
Maximum Length:
10
The phone area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The phone country code of the contact. -
PhoneExtension: string
Maximum Length:
20
The phone extension of the contact. -
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. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code of the contact. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates if the current project contact is the primary contact. The value 'Y' indicates that the project contact is the primary contact and the value 'N' indicates that the contact is not the primary contact. The default value is 'N'. -
ProjectCode: string
Title:
Project ID
Maximum Length:30
The unique identifier of the project. -
Province: string
Title:
Province
Maximum Length:60
The name of the province of the project contact. -
State: string
Title:
State
Maximum Length:60
The name of the state of the project contact.
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.