Create an address for a supplier registration request
post
/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=
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-
AdditionalAddressAttribute1: string
Maximum Length:
150First additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute2: string
Maximum Length:
150Second additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute3: string
Maximum Length:
150Third additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute4: string
Maximum Length:
150Fourth additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute5: string
Maximum Length:
150Fifth additional address attribute for the flexible supplier address format. -
addressContacts: array
Address Contacts
Title:
Address ContactsThe Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240First line of the supplier address. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240Second line of the supplier address. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240Third line of the supplier address. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240Forth line of the supplier address. -
AddressName: string
Title:
Address NameMaximum Length:240Name 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:
BuildingMaximum Length:240Building of the supplier address. -
City: string
Title:
City or LocalityMaximum Length:60City of the supplier address. -
CountryCode: string
Title:
CountryMaximum Length:60Abbreviation that identifies the country where the supplier address is located. -
County: string
Title:
CountyMaximum Length:60Country of the supplier address. -
DFF: array
DFF
-
Email: string
Title:
EmailMaximum Length:320Email for the supplier address. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:10Abbreviation that identifies the area for the fax of the supplier address. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax of the supplier address. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax number of the supplier address. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of the supplier address. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10Abbreviation that identifies the area for phone number of the supplier address. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the phone of the supplier address. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Phone extension of the supplier address. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Phone number of the supplier address. -
PhoneticAddress: string
Title:
Address Lines PhoneticMaximum Length:560Japanese kana or Chinese kanji phonetic representation of the address lines. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the supplier address. -
PostalCodeExtension: string
Title:
Postal Code ExtensionMaximum Length:10Four-digit extension to the postal code of the supplier address. -
Province: string
Title:
ProvinceMaximum Length:60Province of the supplier address. -
State: string
Title:
State or RegionMaximum Length:60State of the supplier address. -
SupplierRegistrationAddressId: integer
Value that uniquely identifies the supplier registration request address.
Nested Schema : Address Contacts
Type:
arrayTitle:
Address ContactsThe Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource.
Show Source
Nested Schema : supplierRegistrationRequests-addresses-addressContacts-item-post-request
Type:
Show Source
object-
Email: string
Email of the supplier contact in the registration.
-
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 : supplierRegistrationRequests-addresses-DFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Enter Party Site InformationMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Enter Party Site Information -
AddressRequestId: integer
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.
Root Schema : supplierRegistrationRequests-addresses-item-response
Type:
Show Source
object-
AdditionalAddressAttribute1: string
Maximum Length:
150First additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute2: string
Maximum Length:
150Second additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute3: string
Maximum Length:
150Third additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute4: string
Maximum Length:
150Fourth additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute5: string
Maximum Length:
150Fifth additional address attribute for the flexible supplier address format. -
addressContacts: array
Address Contacts
Title:
Address ContactsThe Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240First line of the supplier address. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240Second line of the supplier address. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240Third line of the supplier address. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240Forth line of the supplier address. -
AddressName: string
Title:
Address NameMaximum Length:240Name 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:
BuildingMaximum Length:240Building of the supplier address. -
City: string
Title:
City or LocalityMaximum Length:60City of the supplier address. -
CountryCode: string
Title:
CountryMaximum Length:60Abbreviation that identifies the country where the supplier address is located. -
County: string
Title:
CountyMaximum Length:60Country of the supplier address. -
DFF: array
DFF
-
Email: string
Title:
EmailMaximum Length:320Email for the supplier address. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:10Abbreviation that identifies the area for the fax of the supplier address. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax of the supplier address. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax number of the supplier address. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of the supplier address. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:10Abbreviation that identifies the area for phone number of the supplier address. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the phone of the supplier address. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Phone extension of the supplier address. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Phone number of the supplier address. -
PhoneticAddress: string
Title:
Address Lines PhoneticMaximum Length:560Japanese kana or Chinese kanji phonetic representation of the address lines. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the supplier address. -
PostalCodeExtension: string
Title:
Postal Code ExtensionMaximum Length:10Four-digit extension to the postal code of the supplier address. -
Province: string
Title:
ProvinceMaximum Length:60Province of the supplier address. -
State: string
Title:
State or RegionMaximum Length:60State of the supplier address. -
SupplierRegistrationAddressId: integer
Value that uniquely identifies the supplier registration request address.
Nested Schema : Address Contacts
Type:
arrayTitle:
Address ContactsThe Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 InformationMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Enter Party Site Information -
AddressRequestId: integer
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- SupplierRegistrationAddressId:
$request.path.SupplierRegistrationAddressId - SupplierRegistrationKey:
$request.path.SupplierRegistrationKey
- SupplierRegistrationAddressId:
- addressContacts
-
Parameters:
- SupplierRegistrationAddressId:
$request.path.SupplierRegistrationAddressId - SupplierRegistrationKey:
$request.path.SupplierRegistrationKey
The Address Contacts resource manages contacts added to the address for the Suppliers Registration Requests resource. - SupplierRegistrationAddressId: