Get one contact

get

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts/{SupplierContactId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : suppliers-contacts-item-response
Type: object
Show Source
  • Contact Addresses
    Title: Contact Addresses
    The Contact Addresses resource manages supplier contact addresses.
  • Title: Administrative contact
    Maximum Length: 255
    Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier is not an administrative contact. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the supplier record.
  • Title: Creation Date
    Read Only: true
    Date when the user created the supplier record.
  • Flexfields for Supplier Contacts
    Title: Flexfields for Supplier Contacts
    The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.
  • Title: Email
    Maximum Length: 320
    Email of the supplier contact.
  • Title: Fax Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the fax of the supplier contact.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax of the supplier contact.
  • Title: Fax
    Maximum Length: 40
    Fax of the supplier contact.
  • Title: First Name
    Maximum Length: 150
    First name of the supplier contact.
  • Title: Inactive Date
    Date when the supplier contact is no longer active.
  • Title: Job Title
    Maximum Length: 100
    Job title of the supplier contact.
  • Title: Last Name
    Maximum Length: 150
    Last name of the supplier contact.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the supplier record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier record.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the supplier contact.
  • Title: Mobile Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the mobile phone of the supplier contact.
  • Title: Mobile Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the mobile phone of the supplier contact.
  • Title: Mobile
    Maximum Length: 40
    Mobile phone number of the supplier contact.
  • Value that uniquely identifies the person profile.
  • Title: Phone Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the phone of the supplier contact.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the phone of the supplier contact.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension for the supplier contact.
  • Title: Phone
    Maximum Length: 40
    Phone for the supplier contact.
  • Title: Salutation
    Maximum Length: 80
    Honorific title of the supplier contact.
  • Title: Salutation
    Maximum Length: 30
    Abbreviation that identifies the honorific title of the supplier contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Status of the supplier contact.
  • Read Only: true
    Value that uniquely identifies the supplier contact.
Nested Schema : Contact Addresses
Type: array
Title: Contact Addresses
The Contact Addresses resource manages supplier contact addresses.
Show Source
Nested Schema : Flexfields for Supplier Contacts
Type: array
Title: Flexfields for Supplier Contacts
The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.
Show Source
Nested Schema : suppliers-contacts-addresses-item-response
Type: object
Show Source
Nested Schema : suppliers-contacts-DFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one contact.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/contacts/SupplierContactId"

For example, the following command gets one contact where the supplier contact identifier is 88527:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "SupplierContactId" : 88527,
  "PersonProfileId" : 73153,
  "SalutationCode" : null,
  "Salutation" : null,
  "FirstName" : "Henry",
  "MiddleName" : null,
  "LastName" : "Jones",
  "JobTitle" : null,
  "AdministrativeContactFlag" : false,
  "PhoneCountryCode" : null,
  "PhoneAreaCode" : null,
  "PhoneNumber" : null,
  "PhoneExtension" : null,
  "MobileCountryCode" : null,
  "MobileAreaCode" : null,
  "MobileNumber" : null,
  "FaxCountryCode" : null,
  "FaxAreaCode" : null,
  "FaxNumber" : null,
  "Email" : null,
  "Status" : "ACTIVE",
  "InactiveDate" : null
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527",
    "name" : "contacts",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000067704000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000371007E000371007E000371007E000371007E000378"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527",
    "name" : "contacts",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230",
    "name" : "suppliers",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527/lov/SalutationLookup",
    "name" : "SalutationLookup",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527/child/DFF",
    "name" : "DFF",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/88527/child/addresses",
    "name" : "addresses",
    "kind" : "collection"
  } ]
}
Back to Top