Get an address
get
/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Request
Path Parameters
-
AddressNumber(required): string
An alphanumeric number that uniquely identifies the address for a subscription account.
-
SubscrAccountNumber(required): string
The alternate unique identifier of the subscription account.
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 : subscriptionAccounts-subscriptionAccountAddress-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address. -
AddressId: integer
(int64)
Title:
Address Identifier
Read Only:true
The unique identifier of the subscription account address record. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Address Number
Maximum Length:30
An alphanumeric number that uniquely identifies the address for a subscription account. -
AddressType: string
Title:
Address Type
Maximum Length:100
The address type is the static choice list with values indicating the type of address -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number of a given address. -
City: string
Title:
City
Maximum Length:60
The city component of a postal address. -
Country: string
Title:
Country
Maximum Length:2
The country component of a postal address. -
County: string
Title:
County
Maximum Length:60
The country component of a postal address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the subscription account address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the subscription account address was created. -
CustomerAccountId: string
Read Only:
true
The unique identifier of the customer account. -
CustomerAccountSiteId: string
Read Only:
true
The unique identifier of the customer account side. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the subscription account address can be deleted. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The complete street address of a location. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The complete street address of a location. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the subscription account address was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the subscription account address. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the subscription account address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
The location of the subscription account address. -
PartySiteId: string
Read Only:
true
The unique identifier of the party address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the subscription account address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary Address
Maximum Length:1
Default Value:false
Indicates the primary address of a subscription account. -
Province: string
Title:
Province
Maximum Length:60
The name of the province for address of resource. -
SetCode: string
Read Only:
true
The reference set of the record. -
SetId: string
Read Only:
true
The unique identifier of the set. -
SiteUseId: string
Read Only:
true
The unique identifier of the party site usage. -
State: string
Title:
State
Maximum Length:60
The state component of a postal address. -
SubscrAccountNumber: string
Title:
Subscription Account Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the subscription account. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the subscription account address can be updated.
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
- AddressTypeListVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_SUBSC_ACC_ADDRESS_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AddressType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CountryVA
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- YesNoPrimaryVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: PrimaryFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: