Jump to

• Request
• Response
• Examples

Get an address style format

get

/crmRestApi/resources/11.13.18.05/addressStyleFormats/{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 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 : addressStyleFormats-item-response

Type: object

Show Source

• AddressStyleFormatLayout: array Address Style Format Layouts
  Title: Address Style Format Layouts

  The address style format layouts 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.

{
    "type":"object",
    "properties":{
        "StyleFormatCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddressStyleFormatLayout":{
            "title":"Address Style Format Layouts",
            "type":"array",
            "description":"The address style format layouts 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.",
            "items":{
                "$ref":"#/components/schemas/addressStyleFormats-AddressStyleFormatLayout-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StyleFormatName":{
            "maxLength":"240",
            "type":"string",
            "description":"The style fomat name for the address style format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CountryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "maxLength":"80",
            "type":"string",
            "description":"The country name for the address style format.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Address Style Format Layouts

Type: array

Title: Address Style Format Layouts

The address style format layouts 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

• Array of: object addressStyleFormats-AddressStyleFormatLayout-item-response

{
    "title":"Address Style Format Layouts",
    "type":"array",
    "description":"The address style format layouts 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.",
    "items":{
        "$ref":"#/components/schemas/addressStyleFormats-AddressStyleFormatLayout-item-response"
    }
}

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 : addressStyleFormats-AddressStyleFormatLayout-item-response

Type: object

Show Source

• AttributeLabel: string
  Read Only: true

  Maximum Length: 80

  The address field label or prompt in address format layout.
• AttributeName: string
  Read Only: true

  Maximum Length: 120

  The address field name in address format layout.
• DelimiterAfter: string
  Read Only: true

  Maximum Length: 20

  Indicates that one or more characters to be placed after attribute if attribute is not null.
• DelimiterBefore: string
  Read Only: true

  Maximum Length: 20

  Indicates that one or more characters to be placed before attribute if attribute is not null.
• GeographyLevel: integer
  Read Only: true

  The geography level of the address field in address format layout.
• GeographyType: string
  Read Only: true

  Maximum Length: 30

  The geography type of the address field in address format layout. If undefined, the value is NULL.
• LineNumber: integer (int32)
  Read Only: true

  The 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 attribute is mandatory for layout or not. This value is based on the address format.
• Position: integer (int32)
  Read Only: true

  The position on the line where the attribute should be placed.
• UppercaseFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether attribute should be translated to uppercase or not.

{
    "type":"object",
    "properties":{
        "AttributeLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The address field label or prompt in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Position":{
            "type":"integer",
            "description":"The 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":"The geography type of the address field in address format layout. If undefined, the value is NULL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UppercaseFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether attribute should be translated to uppercase or not.",
            "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":"The address field name in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelimiterBefore":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates that one or more characters to be placed before attribute if attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyLevel":{
            "type":"integer",
            "description":"The geography level of the address field in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "type":"integer",
            "description":"The 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 to be placed after attribute if attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether attribute is mandatory for 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."
        }
    }
}

Links

AddressStyleFormatLayout

Operation: /crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout

Parameters:

• CountryCode: $request.path.CountryCode

The address style format layouts 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.

Back to Top

Examples

The following example shows how to get an address style format by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/addressStyleFormats/AF

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
            "CountryCode": "AF",
            "CountryName": "Afghanistan",
            "StyleFormatCode": "POSTAL_ADDR_DEF",
            "StyleFormatName": "Default Postal Address Format",
            "links": [
                ...
            ]
       }

Back to Top