Jump to

• Request
• Response

Get a project contact

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjects/{publicSectorProjectsUniqID}/child/ProjectContact/{ContactKey}

Request

Path Parameters

• ContactKey(required): integer(int64)
  The unique identifier for a project contact.
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorProjects-ProjectContact-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary project contact. If the value is Y, then the project contact is the primary project contact. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The name suffix of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for the project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactProfileId":{
            "type":"integer",
            "description":"The unique identifier for the personal profile of the project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code of the contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code of the contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizPartyId":{
            "type":"integer",
            "description":"The party ID of the business associated with the project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactKey":{
            "type":"integer",
            "description":"The unique identifier for a project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The party ID of the project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the project contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "maxLength":30,
            "type":"string",
            "description":"The prefix for the project contact name. For example, Dr., Professor, etc.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The full name of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the project contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizProfileId":{
            "type":"integer",
            "description":"The unique identifier for the business profile of the project contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the project contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The extension of the contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":10,
            "type":"string",
            "description":"The postal plus four code of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country of the project contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeName":{
            "title":"Contact Type",
            "maxLength":255,
            "type":"string",
            "description":"The name of the project contact type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the project contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top