Update All Host Company or Partner Organization Details
put
/rest/v16/companies/{companyLoginName}
This endpoint replaces all host company or partner organization details with that specified in the request.
Request
Supported Media Types
- application/json
Path Parameters
-
companyLoginName(required): string
Company login name.
Root Schema : Company Details
Type:
object
Title:
Show Source
Company Details
-
address1:
string
Title:
Address 1
Company address1. -
address2:
string
Title:
Address 2
Company address2. -
baseCurrency:
object Currency
Title:
Currency
Base currency of the company. Value holds the currency code. -
baseLanguage:
object Base Language
Title:
Base Language
Base language of the company. Value holds the language code. -
city:
string
Title:
City
City of the company. -
country:
string
Title:
Country
Country of the company. -
dateTimeFormat:
object Date/Time Format
Title:
Date/Time Format
Company preferred date time format. -
email(required):
string
Title:
Email
Email of the company. -
enabledForSSO:
boolean
Title:
Enabled for SSO
Is the company enabled for user login with SSO credentials? -
faxNumber:
string
Title:
Fax Number
Fax of the company. -
login(required):
string
Title:
Login Name
Company login name. -
maximumUsers:
number
Title:
Maximum Users
The maximum number of active users that the company allows to provide access. -
name(required):
string
Title:
Name
Name of the company. -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of the company. -
phoneNumber:
integer
Title:
Phone Number
Phone number of the company. -
state:
string
Title:
State
State province of the company. -
supportedCurrencies(required):
object Supported Currencies
Title:
Supported Currencies
Currencies that are supported by the company. -
supportedLanguages(required):
object Supported Languages
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates). -
timeZone:
object Time Zone
Title:
Time Zone
Company preferred timezone. -
units:
object Units
Title:
Units
Company preferred units. -
zip:
string
Title:
Zip Code
Zip code.
Nested Schema : Currency
Type:
object
Title:
Currency
Base currency of the company. Value holds the currency code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Base Language
Type:
object
Title:
Base Language
Base language of the company. Value holds the language code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Date/Time Format
Type:
object
Title:
Date/Time Format
Company preferred date time format.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Number Format
Type:
object
Title:
Number Format
Preferred number format of the company.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Supported Currencies
Type:
object
Title:
Supported Currencies
Currencies that are supported by the company.
Show Source
Nested Schema : Supported Languages
Type:
object
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates).
Show Source
Nested Schema : Time Zone
Type:
object
Title:
Time Zone
Company preferred timezone.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Units
Type:
object
Title:
Units
Company preferred units.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Currency Details
Title:
Currency Details
Nested Schema : Currency Details
Type:
object
Title:
Show Source
Currency Details
-
currencyCode:
string
Title:
Currency Code
Currency code. -
currencyName:
string
Title:
Currency Name
Currency name. -
isBaseCurrency:
boolean
Title:
Is Base Currency
Is base currency? -
isEnabled:
boolean
Title:
Is Enabled
Is enabled? -
precision:
integer
Title:
Precision Value
Precision value.
Nested Schema : language
Type:
Show Source
object
-
languageCode:
string
Title:
Language Code
Language Code -
languageNumber:
integer
Title:
Language Number
Unique language number.
Response
Supported Media Types
- application/json
Default Response
Company details.
Root Schema : Company Details
Type:
object
Title:
Show Source
Company Details
-
access:
string
Title:
Access
Company access status to login granted/denied. -
activeLicensedUsers:
number
Title:
Active Licensed Users
Number of active users. -
address1:
string
Title:
Address 1
Company address 1. -
address2:
string
Title:
Address 2
Company address 2. -
baseCurrency:
object Currency
Title:
Currency
Base currency of the company. Value holds currency code. -
baseLanguage:
object Base Language
Title:
Base Language
Base language of the company. Value holds the language code. -
city:
string
Title:
City
City of the company. -
country:
string
Title:
Country
Country of the company. -
dateTimeFormat:
object Date/Time Format
Title:
Date/Time Format
Company preferred date time format. -
email:
string
Title:
Email
Email of the company. -
enabledForSSO:
boolean
Title:
Enabled for SSO
Is the company enabled for user login with SSO credentials? -
faxNumber:
string
Title:
Fax Number
Fax of the company. -
links:
array Links
Title:
Links
Links to the related objects. -
login:
string
Title:
Login Name
Company login name. -
maximumUsers:
number
Title:
Maximum Users
The maximum number of active users that the company allows to provide access. -
name:
string
Title:
Name
Name of the company. -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of the company. -
phoneNumber:
integer
Title:
Phone Number
Phone number of the company. -
state:
string
Title:
State
State province of the company. -
styleSheets:
object Style Sheets
Title:
Style Sheets
StyleSheets of the company. -
subscriptionPlan:
string
Title:
Subscription Plan
Subscription plan. -
supportedCurrencies:
object Supported Currencies
Title:
Supported Currencies
Currencies that are supported by the company. -
supportedLanguages:
object Supported Languages
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates). -
timeZone:
object TimeZone of the company
Title:
TimeZone of the company
Company preferred timezone. -
translations:
object Translations
Title:
Translations
Translations of the company. -
units:
object Units
Title:
Units
Company preferred units. -
zip:
string
Title:
Zip Code
Zip code.
Nested Schema : Currency
Type:
object
Title:
Currency
Base currency of the company. Value holds currency code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Base Language
Type:
object
Title:
Base Language
Base language of the company. Value holds the language code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Date/Time Format
Type:
object
Title:
Date/Time Format
Company preferred date time format.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Number Format
Type:
object
Title:
Number Format
Preferred number format of the company.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Style Sheets
Type:
object
Title:
Style Sheets
StyleSheets of the company.
Show Source
Nested Schema : Supported Currencies
Type:
object
Title:
Supported Currencies
Currencies that are supported by the company.
Show Source
Nested Schema : Supported Languages
Type:
object
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates).
Show Source
Nested Schema : TimeZone of the company
Type:
object
Title:
TimeZone of the company
Company preferred timezone.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Translations
Type:
object
Title:
Translations
Translations of the company.
Show Source
Nested Schema : Units
Type:
object
Title:
Units
Company preferred units.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Nested Schema : companyStyleSheet-collection
Type:
Show Source
object
-
items:
array Style Sheet Collection
Title:
Style Sheet Collection
List of style sheets. -
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Style Sheet Collection
Type:
array
Title:
Style Sheet Collection
List of style sheets.
Show Source
-
Array of:
object Style Sheet
Title:
Style Sheet
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Style Sheet
Type:
object
Title:
Show Source
Style Sheet
-
links:
array Links
Title:
Links
Links to current objects. -
name:
string
Title:
Style Sheet Name
Unique name for the style sheet.
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Currency Details
Title:
Currency Details
Nested Schema : Currency Details
Type:
object
Title:
Show Source
Currency Details
-
currencyCode:
string
Title:
Currency Code
Currency code. -
currencyName:
string
Title:
Currency Name
Currency name. -
isBaseCurrency:
boolean
Title:
Is Base Currency
Is base currency? -
isEnabled:
boolean
Title:
Is Enabled
Is enabled? -
precision:
integer
Title:
Precision Value
Precision value.
Nested Schema : language
Type:
Show Source
object
-
languageCode:
string
Title:
Language Code
Language Code -
languageNumber:
integer
Title:
Language Number
Unique language number.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Company Translations
Title:
Company Translations
Nested Schema : Company Translations
Type:
object
Title:
Show Source
Company Translations
-
items:
array Company Translations List
Title:
Company Translations List
-
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Company Translations List
Type:
array
Title:
Show Source
Company Translations List
-
Array of:
object Company Translation
Title:
Company Translation
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Company Translation
Type:
object
Title:
Show Source
Company Translation
-
language:
object Translation Language
Title:
Translation Language
-
links:
array Links
Title:
Links
Links to current objects. -
name:
string
Title:
Company Translation Name
Company translation name in specific language.
Nested Schema : Translation Language
Type:
object
Title:
Show Source
Translation Language
-
languageCode:
string
Title:
Language Code
Translation message language name. -
languageNumber:
string
Title:
Language Number
Language sequence number in supported language list. -
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Examples
The following example shows how to replace all host company or partner organization details with that specified in the request by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X PUT -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies/visionServices
Request Body Sample
} "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "isEnabled": true }, { "currencyCode": "AUD", "isEnabled": false }, { "currencyCode": "CAD", "isEnabled": true }, { "currencyCode": "CNY", "isEnabled": true } ] }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "maximumUsers": 11 }
Response Body Sample
{ "name": "Vision Services", "login": "visionServices", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "noreply@yourcompany.com", "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "zh_CN", "languageName": "Chinese (Simplified) [China]", "iso2LanguageCode": "zh", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "zh_TW", "languageName": "Chinese (Traditional) [Taiwan]", "iso2LanguageCode": "zh", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "cs_CZ", "languageName": "Czech [Czech Republic]", "iso2LanguageCode": "cs", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ]"maximumUsers": 11 }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/companies/visionServices" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v16/companies/visionServices/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v16/companies/visionServices/users" } ] }