Collaboration APIs

GET collaboration/contacts/{contactId}/addresses

List of addresses for the provided contact

HTTP method	GET
URI	https://api.rambase.net/collaboration/contacts/{contactId}/addresses
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {contactId}	Contact identifier Integer, minimum 100000
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	322, version 8

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AddressId Integer	Address identifier.
AddressLine1 String	First address line.
AddressLine2 String	Second address line.
Attention String	Attention note.
City String	City/town/village.
Country String	English name of country.
CountryCode String	Two-character code (ISO 3166) identifying the country.
CreatedAt Datetime	Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Firstname String	Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
Name String	Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
PostalCode String	Postalcode/Postcode/ZIP.
Region String	Region/province/state.
Type String	Type of address.

Read more about filters and sorting on how to use sortable parameters

AddressId Integer	Address identifier
AddressLine1 String	First address line
AddressLine2 String	Second address line
Attention String	Attention note.
City String	City/town/village
Country String	English name of country.
CountryCode String	Two-character code (ISO 3166) identifying the country.
CreatedAt Datetime	Date and time of creation
Firstname String	Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
Name String	Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
PostalCode String	Postalcode/Postcode/ZIP
Region String	Region/province/state
Type String	Type of address

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <Addresses>
                                    

                                             <Address>
                                    

<AddressId

AddressId

Address identifier

>{Integer}</AddressId>

<Type

Type

Type of address

Possible domain values can be found here

>{String}</Type>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Name

Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>

<Firstname

Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>

<IsDefault

IsDefault

True if this is the default communication type

>{Boolean}</IsDefault>

<Attention

Attention

Attention note.

>{String}</Attention>

<AddressLine1

AddressLine1

First address line

>{String}</AddressLine1>

<AddressLine2

AddressLine2

Second address line

>{String}</AddressLine2>

<PostalCode

PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>

<City

City

City/town/village

>{String}</City>

<Region

Region

Region/province/state

>{String}</Region>

<Country

Country

English name of country.

>{String}</Country>

<CountryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>

<AddressLink

AddressLink

Address reference

>{String}</AddressLink>

                                             </Address>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Addresses>
                                    

{

                                             "addresses": [
                                    

{

"addressId

AddressId

Address identifier

": "{Integer}",

"type

Type

Type of address

Possible domain values can be found here

": "{String}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"name

Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",

"firstname

Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",

"isDefault

IsDefault

True if this is the default communication type

": "{Boolean}",

"attention

Attention

Attention note.

": "{String}",

"addressLine1

AddressLine1

First address line

": "{String}",

"addressLine2

AddressLine2

Second address line

": "{String}",

"postalCode

PostalCode

Postalcode/Postcode/ZIP

": "{String}",

"city

City

City/town/village

": "{String}",

"region

Region

Region/province/state

": "{String}",

"country

Country

English name of country.

": "{String}",

"countryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",

"addressLink

AddressLink

Address reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100034 HTTP 404

Contact not found