Jump to

• Request
• Response

Get an address style format layout

get

/fscmRestApi/resources/11.13.18.05/supplierRegistrationAddressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout/{AddressStyleFormatLayoutUniqID}

Request

Path Parameters

• AddressStyleFormatLayoutUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Address Style Format Layouts resource and used to uniquely identify an instance of Address Style Format Layouts. The client should not generate the hash key value. Instead, the client should query on the Address Style Format Layouts collection resource in order to navigate to a specific instance of Address Style Format Layouts to get the hash key.
• 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 Top

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.

Body ()

Root Schema : supplierRegistrationAddressStyleFormats-AddressStyleFormatLayout-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AttributeLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"Address field label or prompt in the address style format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Position":{
            "type":"integer",
            "description":"Position on the line where the attribute should be placed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "GeographyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Geography type of the address field in the address style format layout. If it's undefined, the value is NULL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UppercaseFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute should be converted to uppercase or not in the English translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":"120",
            "type":"string",
            "description":"Fielld name in the address style format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelimiterBefore":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates that one or more characters are to be inserted before the attribute if the attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyLevel":{
            "type":"integer",
            "description":"Geography level of the address field in the address style format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "type":"integer",
            "description":"Line on which the attribute should be formatted.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "DelimiterAfter":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates that one or more characters are to be inserted after the attribute if the attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute is mandatory for the layout or not. This value is based on the address format.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top