Get an address style format
get
/fscmRestApi/resources/11.13.18.05/supplierRegistrationAddressStyleFormats/{CountryCode}
Request
Path Parameters
-
CountryCode(required): string
The country code for the address style format. This value can be added by the user or left blank. Ifmanually added, the address style format for a country code will be returned, else, if left blank, the entire list of available address style formats will be returned.
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:
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 : supplierRegistrationAddressStyleFormats-item-response
Type:
Show Source
object
-
AddressStyleFormatLayout: array
Address Style Format Layouts
Title:
Address Style Format Layouts
The Address Style Format Layout resource is used to view the layout of an address format. The address format layout is determined using the components in the address and their position in the layout. -
CountryCode: string
Read Only:
true
Maximum Length:2
The country code for the address style format. This value can be added by the user or left blank. Ifmanually added, the address style format for a country code will be returned, else, if left blank, the entire list of available address style formats will be returned. -
CountryName: string
Read Only:
true
Maximum Length:80
The country name for the address style format. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StyleFormatCode: string
Read Only:
true
Maximum Length:30
The style format code for the address style format. If this value is not defined then the default postal style format code is returned. For example, for US, the default stryle format code is POSTAL_ADDR_US. -
StyleFormatName: string
Read Only:
true
Maximum Length:240
The style fomat name for the address style format.
Nested Schema : Address Style Format Layouts
Type:
array
Title:
Address Style Format Layouts
The Address Style Format Layout resource is used to view the layout of an address format. The address format layout is determined using the components in the address and their position in the layout.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierRegistrationAddressStyleFormats-AddressStyleFormatLayout-item-response
Type:
Show Source
object
-
AttributeLabel: string
Read Only:
true
Maximum Length:80
Address field label or prompt in the address style format layout. -
AttributeName: string
Read Only:
true
Maximum Length:120
Fielld name in the address style format layout. -
DelimiterAfter: string
Read Only:
true
Maximum Length:20
Indicates that one or more characters are to be inserted after the attribute if the attribute is not null. -
DelimiterBefore: string
Read Only:
true
Maximum Length:20
Indicates that one or more characters are to be inserted before the attribute if the attribute is not null. -
GeographyLevel: integer
Read Only:
true
Geography level of the address field in the address style format layout. -
GeographyType: string
Read Only:
true
Maximum Length:30
Geography type of the address field in the address style format layout. If it's undefined, the value is NULL. -
LineNumber: integer
(int32)
Read Only:
true
Line on which the attribute should be formatted. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the attribute is mandatory for the layout or not. This value is based on the address format. -
Position: integer
(int32)
Read Only:
true
Position on the line where the attribute should be placed. -
UppercaseFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the attribute should be converted to uppercase or not in the English translation.
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.
Links
- AddressStyleFormatLayout
-
Parameters:
- CountryCode:
$request.path.CountryCode
The Address Style Format Layout resource is used to view the layout of an address format. The address format layout is determined using the components in the address and their position in the layout. - CountryCode: