Base APIs

GET base/postal-code-definitions

List postal code definitions

HTTP method	GET
URI	https://api.rambase.net/base/postal-code-definitions
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	2210, version 6

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.

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

City String	City/Town/Village.
CountryCode String	Country code the postal code belongs to.
PostalCode String	PostalCode/Postcode/ZIP. Note that the postal code is unique within a country.
PostalCodeDefinitionId Integer	Postal code definition identifier.
Status Integer	Status of postal code definition.

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

City String	City/Town/Village
CountryCode String	Country code the postal code belongs to
PostalCode String	PostalCode/Postcode/ZIP. Note that the postal code is unique within a country
PostalCodeDefinitionId Integer	Postal code definition identifier
Status Integer	Status of postal code definition

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:

                                        <PostalCodeDefinitions>
                                    

                                             <PostalCodeDefinition>
                                    

<PostalCodeDefinitionId

PostalCodeDefinitionId

Postal code definition identifier

>{String}</PostalCodeDefinitionId>

<Status

Status

Status of postal code definition

>{Integer}</Status>

<PostalCode

PostalCode

PostalCode/Postcode/ZIP. Note that the postal code is unique within a country

>{String}</PostalCode>

<City

City

City/Town/Village

>{String}</City>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

                                                  <Country>
                                    

<CountryId

CountryId

Country identifier

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

>{Integer}</CountryId>

<Name

Name

Name of country

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

>{String}</Name>

<CountryCode

CountryCode

Country code the postal code belongs to

>{String}</CountryCode>

<CountryLink

CountryLink

Country reference

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

>{String}</CountryLink>

                                                  </Country>
                                    

<PostalCodeDefinitionLink

PostalCodeDefinitionLink

Postal code reference

>{String}</PostalCodeDefinitionLink>

                                             </PostalCodeDefinition>
                                    

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

                                        </PostalCodeDefinitions>
                                    

{

                                             "postalCodeDefinitions": [
                                    

{

"postalCodeDefinitionId

PostalCodeDefinitionId

Postal code definition identifier

": "{String}",

"status

Status

Status of postal code definition

": "{Integer}",

"postalCode

PostalCode

PostalCode/Postcode/ZIP. Note that the postal code is unique within a country

": "{String}",

"city

City

City/Town/Village

": "{String}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

                                                       "country": {
                                    

"countryId

CountryId

Country identifier

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

": "{Integer}",

"name

Name

Name of country

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

": "{String}",

"countryCode

CountryCode

Country code the postal code belongs to

": "{String}",

"countryLink

CountryLink

Country reference

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

": "{String}"

},

"postalCodeDefinitionLink

PostalCodeDefinitionLink

Postal code 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: