Get all supplier contacts for a supplier registration

get

/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests/{SupplierRegistrationKey}/child/contacts

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
  • 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 supplier contact in supplier registration according to the primary key.
      Finder Variables
      • SupplierRegistrationContactId; integer; Value that uniquely identifies the supplier contact in the registration using the contact identifier.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AdministrativeContactFlag; boolean; Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier isn't an administrative contact.The default value is false.
    • CreateUserAccountFlag; boolean; Contains one of the following values: true or false. If true, create a user account for the supplier contact. If false, then don't create a user account for the supplier contact. The default value is false.
    • Email; string; Email of the supplier contact in the registration.
    • FaxAreaCode; string; Abbreviation that identifies the area for the fax number of the supplier contact in the supplier registration.
    • FaxCountryCode; string; Abbreviation that identifies the country for the fax number of the supplier contact in the supplier registration.
    • FaxNumber; string; Fax number of the supplier contact in the supplier registration.
    • FirstName; string; First name of the supplier contact in the supplier registration.
    • JobTitle; string; Job title of the supplier contact in the supplier registration.
    • LastName; string; Last name of the supplier contact in the supplier registration.
    • MiddleName; string; Middle name of the supplier contact in the supplier registration.
    • MobileAreaCode; string; Abbreviation that identifies the area for the mobile phone number of the supplier contact in the supplier registration.
    • MobileCountryCode; string; Abbreviation that identifies the country for the mobile phone number of the supplier contact in the supplier registration.
    • MobileNumber; string; Mobile phone number of the supplier contact in the supplier registration.
    • PhoneAreaCode; string; Abbreviation that identifies the area for the landline phone number of the supplier contact in the supplier registration.
    • PhoneCountryCode; string; Abbreviation that identifies the country for the landline phone number of the supplier contact in the supplier registration.
    • PhoneExtension; string; Landline phone extension for the supplier contact in the supplier registration.
    • PhoneNumber; string; Landline phone number for the supplier contact in the supplier registration.
    • Salutation; string; Honorific title of the supplier contact in the supplier registration.
    • SalutationCode; string; Abbreviation that identifies the honorific title of the supplier contact in the supplier registration. 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.
    • SupplierRegistrationContactId; integer; Value that uniquely identifies a supplier contact in the supplier registration.
  • 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
  • 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 : supplierRegistrationRequests-contacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierRegistrationRequests-contacts-item-response
Type: object
Show Source
  • Title: Administrative contact
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier isn't an administrative contact.The default value is false.
  • Title: Request user account
    Maximum Length: 1
    Contains one of the following values: true or false. If true, create a user account for the supplier contact. If false, then don't create a user account for the supplier contact. The default value is false.
  • DFF
  • Title: Email
    Maximum Length: 320
    Email of the supplier contact in the registration.
  • Title: Fax Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the fax number of the supplier contact in the supplier registration.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax number of the supplier contact in the supplier registration.
  • Title: Fax
    Maximum Length: 40
    Fax number of the supplier contact in the supplier registration.
  • Title: First Name
    Maximum Length: 150
    First name of the supplier contact in the supplier registration.
  • Title: Job Title
    Maximum Length: 100
    Job title of the supplier contact in the supplier registration.
  • Title: Last Name
    Maximum Length: 150
    Last name of the supplier contact in the supplier registration.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the supplier contact in the supplier registration.
  • Title: Mobile Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the mobile phone number of the supplier contact in the supplier registration.
  • Title: Mobile Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the mobile phone number of the supplier contact in the supplier registration.
  • Title: Mobile
    Maximum Length: 40
    Mobile phone number of the supplier contact in the supplier registration.
  • Title: Phone Area Code
    Maximum Length: 10
    Abbreviation that identifies the area for the landline phone number of the supplier contact in the supplier registration.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the landline phone number of the supplier contact in the supplier registration.
  • Title: Phone Extension
    Maximum Length: 20
    Landline phone extension for the supplier contact in the supplier registration.
  • Title: Phone
    Maximum Length: 40
    Landline phone number for the supplier contact in the supplier registration.
  • Roles
    Title: Roles
    The Roles resource manages user account roles of the supplier contact for supplier registration.
  • Maximum Length: 80
    Honorific title of the supplier contact in the supplier registration.
  • Title: Salutation
    Maximum Length: 30
    Abbreviation that identifies the honorific title of the supplier contact in the supplier registration. 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.
  • Value that uniquely identifies a supplier contact in the supplier registration.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Roles
Type: array
Title: Roles
The Roles resource manages user account roles of the supplier contact for supplier registration.
Show Source
Nested Schema : supplierRegistrationRequests-contacts-DFF-item-response
Type: object
Show Source
Nested Schema : supplierRegistrationRequests-contacts-roles-item-response
Type: object
Show Source
Back to Top