API

Base APIs

GET base/companies/{companyId}

Company details for the provided identifier

HTTP method GET
URI https://api.rambase.net/base/companies/{companyId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {companyId} Company identifier
Integer, minimum 100
Successful HTTP status code 200
API resource identifier 204, version 13

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

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
$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:
1
<Company>
2
     <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
3
     <Status
Status

Status of company. 1 : Not activated, 4 : Active, 9 : Obsolete

>{Integer}</Status>
4
     <Name
Name

Name of company

>{String}</Name>
5
     <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
6
     <PreferredLanguage
PreferredLanguage

Preferred language for this company

Possible domain values can be found here

>{String}</PreferredLanguage>
7
     <LegalEntityIdentifier
LegalEntityIdentifier

The company's unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
8
     <Currency
Currency

The currency this company is using. Three character code following the ISO 4217 standard. Used in backlog, billing, accounting etc.

Possible domain values can be found here

>{String}</Currency>
9
     <TradingAddress>
10
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
11
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
12
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
13
          <City
City

City/town/village

>{String}</City>
14
          <Country>
15
               <CountryId
CountryId

Country identifier

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

>{Integer}</CountryId>
16
               <Name
Name

Name of country

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

>{String}</Name>
17
               <CountryCode
CountryCode

Country code of the company

>{String}</CountryCode>
18
               <CountryLink
CountryLink

Country reference

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

>{String}</CountryLink>
19
          </Country>
20
     </TradingAddress>
21
     <Location>
22
          <Database
Database

Company code/database the object belongs to

>{String}</Database>
23
          <LocationId
LocationId

Company identifier

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

>{Integer}</LocationId>
24
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
25
          <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
26
     </Location>
27
     <InventoryOwnership
InventoryOwnership

The company which is having complete legal control of the inventory.

>
28
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
29
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
30
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
31
     </InventoryOwnership>
32
     <PrintConfiguration
PrintConfiguration

Defalt print configuration used for this company

>
33
          <PrintConfigurationId
PrintConfigurationId

Print configuration identifier

>{Integer}</PrintConfigurationId>
34
          <Name
Name

Name of the print configuration

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

>{String}</Name>
35
          <PrintConfigurationLink
PrintConfigurationLink

Print configuration reference

>{String}</PrintConfigurationLink>
36
     </PrintConfiguration>
37
</Company>
1
{
2
     "company": {
3
          "companyId
CompanyId

Company identifier

": "{Integer}",
4
          "status
Status

Status of company. 1 : Not activated, 4 : Active, 9 : Obsolete

": "{Integer}",
5
          "name
Name

Name of company

": "{String}",
6
          "database
Database

Abbreviation/code to identify the company

": "{String}",
7
          "preferredLanguage
PreferredLanguage

Preferred language for this company

Possible domain values can be found here

": "{String}",
8
          "legalEntityIdentifier
LegalEntityIdentifier

The company's unique enterprise/organization number.

": "{String}",
9
          "currency
Currency

The currency this company is using. Three character code following the ISO 4217 standard. Used in backlog, billing, accounting etc.

Possible domain values can be found here

": "{String}",
10
          "tradingAddress": {
11
               "addressLine1
AddressLine1

First address line

": "{String}",
12
               "addressLine2
AddressLine2

Second address line

": "{String}",
13
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
14
               "city
City

City/town/village

": "{String}",
15
               "country": {
16
                    "countryId
CountryId

Country identifier

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

": "{Integer}",
17
                    "name
Name

Name of country

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

": "{String}",
18
                    "countryCode
CountryCode

Country code of the company

": "{String}",
19
                    "countryLink
CountryLink

Country reference

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

": "{String}"
20
               }
21
          },
22
          "location": {
23
               "database
Database

Company code/database the object belongs to

": "{String}",
24
               "locationId
LocationId

Company identifier

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

": "{Integer}",
25
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
26
               "locationLink
LocationLink

Location reference

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

": "{String}"
27
          },
28
          "inventoryOwnership
InventoryOwnership

The company which is having complete legal control of the inventory.

": {
29
               "companyId
CompanyId

Company identifier

": "{Integer}",
30
               "database
Database

Abbreviation/code to identify the company

": "{String}",
31
               "companyLink
CompanyLink

Company reference

": "{String}"
32
          },
33
          "printConfiguration
PrintConfiguration

Defalt print configuration used for this company

": {
34
               "printConfigurationId
PrintConfigurationId

Print configuration identifier

": "{Integer}",
35
               "name
Name

Name of the print configuration

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

": "{String}",
36
               "printConfigurationLink
PrintConfigurationLink

Print configuration reference

": "{String}"
37
          }
38
     }
39
}

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