Get one address for the supplier registration request
get
/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests/{SupplierRegistrationKey}/child/addresses
Request
Path Parameters
-
SupplierRegistrationKey(required): string
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
-
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 the supplier registration request address according to the primary key.
Finder Variables- SupplierRegistrationAddressId; integer; Value that uniquely identifies the supplier registration request address.
- PrimaryKey Finds the supplier registration request address according to the primary key.
-
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:- SupplierRegistrationAddressId; integer; Value that uniquely identifies the supplier registration request 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:
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.
Root Schema : supplierRegistrationRequests-addresses
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 : supplierRegistrationRequests-addresses-item-response
Type:
Show Source
object
-
AdditionalAddressAttribute1: string
Maximum Length:
150
First additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute2: string
Maximum Length:
150
Second additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute3: string
Maximum Length:
150
Third additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute4: string
Maximum Length:
150
Fourth additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute5: string
Maximum Length:
150
Fifth additional address attribute for the flexible supplier address format. -
addressContacts: array
Address Contacts
Title:
Address Contacts
The Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the supplier address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the supplier address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the supplier address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
Forth line of the supplier address. -
AddressName: string
Title:
Address Name
Maximum Length:240
Name of the supplier address. -
AddressPurposeOrderingFlag: boolean
Contains one of the following values: true or false. If true, then you can use the supplier address for ordering. If false, then you can't use this address. The default value is false.
-
AddressPurposeRemitToFlag: boolean
Contains one of the following values: true or false. If true, then you can use the supplier address for requesting for a proposal or for bidding. If false, then you can't use this address. The default value is false.
-
AddressPurposeRFQOrBiddingFlag: boolean
Contains one of the following values: true or false. If true, then you can use the supplier address to send payment. If false, then you can't use this address. The default value is false.
-
Building: string
Title:
Building
Maximum Length:240
Building of the supplier address. -
City: string
Title:
City or Locality
Maximum Length:60
City of the supplier address. -
CountryCode: string
Title:
Country
Maximum Length:60
Abbreviation that identifies the country where the supplier address is located. -
County: string
Title:
County
Maximum Length:60
Country of the supplier address. -
DFF: array
DFF
-
Email: string
Title:
Email
Maximum Length:320
Email for the supplier address. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:10
Abbreviation that identifies the area for the fax of the supplier address. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
Abbreviation that identifies the country for the fax of the supplier address. -
FaxNumber: string
Title:
Fax
Maximum Length:40
Fax number of the supplier address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
Floor number of the supplier address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Abbreviation that identifies the area for phone number of the supplier address. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Abbreviation that identifies the country for the phone of the supplier address. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
Phone extension of the supplier address. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Phone number of the supplier address. -
PhoneticAddress: string
Title:
Address Lines Phonetic
Maximum Length:560
Japanese kana or Chinese kanji phonetic representation of the address lines. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Postal code of the supplier address. -
PostalCodeExtension: string
Title:
Postal Code Extension
Maximum Length:10
Four-digit extension to the postal code of the supplier address. -
Province: string
Title:
Province
Maximum Length:60
Province of the supplier address. -
State: string
Title:
State or Region
Maximum Length:60
State of the supplier address. -
SupplierRegistrationAddressId: integer
Value that uniquely identifies the supplier registration request address.
Nested Schema : Address Contacts
Type:
array
Title:
Address Contacts
The Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierRegistrationRequests-addresses-addressContacts-item-response
Type:
Show Source
object
-
Email: string
Email of the supplier contact in the registration.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierRegAddressContactsId: integer
Value that uniquely identifies the supplier registration request address contact.
-
SupplierRegistrationContactId: integer
Value that uniquely identifies the supplier registration request 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.
Nested Schema : supplierRegistrationRequests-addresses-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Enter Party Site Information
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Enter Party Site Information
-
AddressRequestId: integer
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source