Jump to

• Request
• Response
• Examples

Get an address purpose

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Request

Path Parameters

• AddressNumber(required): string
  The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• AddressPurposeId(required): integer(int64)
  The unique identifier for the address purpose of an address.
• PartyNumber(required): string
  The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.

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 : contacts-Address-AddressPurpose-item-response

Type: object

Show Source

• AddressId: integer (int64)
  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressPurposeId: integer (int64)
  Read Only: true

  The unique identifier for the address purpose of an address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user comments for the address purpose.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address purpose record.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address purpose record was created.
• DeleteFlag: boolean
  Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
• EndDate: string (date)
  Title: To Date

  The date on which the address purpose is no longer valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address purpose was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address purpose record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address purpose record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryPerType: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
• Purpose: string
  Title: Purpose

  Maximum Length: 30

  The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SiteSourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystem: string
  The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
• SourceSystemReferenceValue: string
  The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• StartDate: string (date)
  Title: From Date

  The date from which the address purpose is valid.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address purpose record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for the address purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "Purpose":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressPurposeId":{
            "type":"integer",
            "description":"The unique identifier for the address purpose of an address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date on which the address purpose is no longer valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryPerType":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which the address purpose is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.",
            "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"
            }
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the address purpose record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address purpose was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Examples

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

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CDRM_336942/child/Address/CDRM_100949/child/AddressPurpose/300100046425239

Example of Response Body

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

{
    "AddressPurposeId": 300100046425239,
    "Purpose": "SHIP_TO",
    "DeleteFlag": null,
    ...
}

Back to Top