Base APIs

GET base/postal-code-definitions/{postalCodeDefinitionId}

Postal code definition details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/base/postal-code-definitions/{postalCodeDefinitionId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {postalCodeDefinitionId}	Postal code definition identifier Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	2211, version 4

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
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

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

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:

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

<Prefix

Prefix

Postal code prefix/Postcode prefix/ZIP prefix

>{String}</Prefix>

<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=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=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=Country.CountryLink in your request URI to get this field

>{String}</CountryLink>

                                             </Country>
                                    

                                        </PostalCodeDefinition>
                                    

{

                                             "postalCodeDefinition": {
                                    

"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}",

"prefix

Prefix

Postal code prefix/Postcode prefix/ZIP prefix

": "{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=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=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=Country.CountryLink in your request URI to get this field

": "{String}"

}

}

}

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 100141 HTTP 404

Country not found