Jump to

• Request
• Response
• Examples

Update Specific Host Company or Partner Organization Details

patch

/rest/v19/companies/{companyLoginName}

This endpoint replaces specific host company or partner organization details with that specified in the web services request.

Request

Supported Media Types

• application/json

Path Parameters

• companyLoginName(required): string
  Company login name.

Body ()

Root Schema : Company Details

Type: object

Title: Company Details

Show Source

• 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: 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 number 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: 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: 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 (supportedLanguages are mandatory only for host company update).
• timeZone: object TimeZone of the company
  Title: TimeZone of the company

  Company preferred timezone.
• units: object Units
  Title: Units

  Company preferred units.
• zip: string
  Title: Zip Code

  Zip code.

{
    "type":"object",
    "required":[
        "login"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the company.",
            "title":"Name"
        },
        "login":{
            "type":"string",
            "description":"Company login name.",
            "title":"Login Name"
        },
        "email":{
            "type":"string",
            "description":"Email of the company.",
            "title":"Email"
        },
        "enabledForSSO":{
            "type":"boolean",
            "description":"Is the company enabled for user login with SSO credentials?",
            "title":"Enabled For SSO"
        },
        "phoneNumber":{
            "type":"integer",
            "description":"Phone number of the company.",
            "title":"Phone Number"
        },
        "faxNumber":{
            "type":"string",
            "description":"Fax number of the company.",
            "title":"Fax Number"
        },
        "address1":{
            "type":"string",
            "description":"Company address1.",
            "title":"Address 1"
        },
        "address2":{
            "type":"string",
            "description":"Company address2.",
            "title":"Address 2"
        },
        "city":{
            "type":"string",
            "description":"City of the company.",
            "title":"City"
        },
        "state":{
            "type":"string",
            "description":"State province of the company.",
            "title":"State"
        },
        "zip":{
            "type":"string",
            "description":"Zip code.",
            "title":"Zip Code"
        },
        "country":{
            "type":"string",
            "description":"Country of the company.",
            "title":"Country"
        },
        "maximumUsers":{
            "type":"number",
            "description":"The maximum number of active users that the company allows to provide access.",
            "title":"Maximum Users"
        },
        "baseLanguage":{
            "type":"object",
            "description":"Base language of the company. Value holds the language code.",
            "title":"Base Language",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "numberFormat":{
            "type":"object",
            "description":"Preferred number format of the company.",
            "title":"Number Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "units":{
            "type":"object",
            "description":"Company preferred units.",
            "title":"Units",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "dateTimeFormat":{
            "type":"object",
            "description":"Company preferred date time format.",
            "title":"Date/Time Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "timeZone":{
            "type":"object",
            "description":"Company preferred timezone.",
            "title":"TimeZone of the company",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "baseCurrency":{
            "type":"object",
            "description":"Base currency of the company. Value holds the currency code.",
            "title":"Currency",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "supportedLanguages":{
            "type":"object",
            "description":"Languages that are supported by the company (supportedLanguages are mandatory only for host company update).",
            "title":"Supported Languages",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/language"
                    }
                }
            }
        },
        "supportedCurrencies":{
            "type":"object",
            "description":"Currencies that are supported by the company.",
            "title":"Supported Currencies",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/currency"
                    }
                }
            }
        }
    },
    "title":"Company Details"
}

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

{
    "type":"object",
    "description":"Base currency of the company. Value holds the currency code.",
    "title":"Currency",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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

{
    "type":"object",
    "description":"Base language of the company. Value holds the language code.",
    "title":"Base Language",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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.

{
    "type":"object",
    "description":"Company preferred date time format.",
    "title":"Date/Time Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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.

{
    "type":"object",
    "description":"Preferred number format of the company.",
    "title":"Number Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Supported Currencies

Type: object

Title: Supported Currencies

Currencies that are supported by the company.

Show Source

• items: array items

{
    "type":"object",
    "description":"Currencies that are supported by the company.",
    "title":"Supported Currencies",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/currency"
            }
        }
    }
}

Nested Schema : Supported Languages

Type: object

Title: Supported Languages

Languages that are supported by the company (supportedLanguages are mandatory only for host company update).

Show Source

• items: array items

{
    "type":"object",
    "description":"Languages that are supported by the company (supportedLanguages are mandatory only for host company update).",
    "title":"Supported Languages",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/language"
            }
        }
    }
}

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.

{
    "type":"object",
    "description":"Company preferred timezone.",
    "title":"TimeZone of the company",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Units

Type: object

Title: Units

Company preferred units.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Company preferred units.",
    "title":"Units",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Currency Details
  Title: Currency Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/currency"
    }
}

Nested Schema : Currency Details

Type: object

Title: Currency Details

Show Source

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

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string",
            "description":"Currency code.",
            "title":"Currency Code"
        },
        "currencyName":{
            "type":"string",
            "description":"Currency name.",
            "title":"Currency Name"
        },
        "precision":{
            "type":"integer",
            "description":"Precision value.",
            "title":"Precision Value"
        },
        "isBaseCurrency":{
            "type":"boolean",
            "description":"Is base currency?",
            "title":"Is Base Currency"
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Is enabled?",
            "title":"Is Enabled"
        }
    },
    "title":"Currency Details"
}

Nested Schema : items

Type: array

Show Source

• Array of: object language

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/language"
    }
}

Nested Schema : language

Type: object

Show Source

• languageCode: string
  Title: Language Code

  Language Code
• languageNumber: integer
  Title: Language Number

  Unique language number.

{
    "type":"object",
    "properties":{
        "languageCode":{
            "$ref":"#/definitions/languageCode"
        },
        "languageNumber":{
            "type":"integer",
            "description":"Unique language number.",
            "title":"Language Number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Company details.

Body ()

Root Schema : Company Details

Type: object

Title: Company Details

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the company.",
            "title":"Name"
        },
        "login":{
            "type":"string",
            "description":"Company login name.",
            "title":"Login Name"
        },
        "email":{
            "type":"string",
            "description":"Email of the company.",
            "title":"Email"
        },
        "enabledForSSO":{
            "type":"boolean",
            "description":"Is the company enabled for user login with SSO credentials?",
            "title":"Enabled for SSO"
        },
        "activeLicensedUsers":{
            "type":"number",
            "description":"Number of active users.",
            "title":"Active Licensed Users"
        },
        "phoneNumber":{
            "type":"integer",
            "description":"Phone number of the company.",
            "title":"Phone Number"
        },
        "faxNumber":{
            "type":"string",
            "description":"Fax of the company.",
            "title":"Fax Number"
        },
        "address1":{
            "type":"string",
            "description":"Company address 1.",
            "title":"Address 1"
        },
        "address2":{
            "type":"string",
            "description":"Company address 2.",
            "title":"Address 2"
        },
        "city":{
            "type":"string",
            "description":"City of the company.",
            "title":"City"
        },
        "state":{
            "type":"string",
            "description":"State province of the company.",
            "title":"State"
        },
        "zip":{
            "type":"string",
            "description":"Zip code.",
            "title":"Zip Code"
        },
        "country":{
            "type":"string",
            "description":"Country of the company.",
            "title":"Country"
        },
        "access":{
            "type":"string",
            "description":"Company access status to login granted/denied.",
            "title":"Access"
        },
        "maximumUsers":{
            "type":"number",
            "description":"The maximum number of active users that the company allows to provide access.",
            "title":"Maximum Users"
        },
        "subscriptionPlan":{
            "type":"string",
            "description":"Subscription plan.",
            "title":"Subscription Plan"
        },
        "baseLanguage":{
            "type":"object",
            "description":"Base language of the company. Value holds the language code.",
            "title":"Base Language",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "numberFormat":{
            "type":"object",
            "description":"Preferred number format of the company.",
            "title":"Number Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "units":{
            "type":"object",
            "description":"Company preferred units.",
            "title":"Units",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "dateTimeFormat":{
            "type":"object",
            "description":"Company preferred date time format.",
            "title":"Date/Time Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "timeZone":{
            "type":"object",
            "description":"Company preferred timezone.",
            "title":"TimeZone of the company",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "baseCurrency":{
            "type":"object",
            "description":"Base currency of the company. Value holds currency code.",
            "title":"Currency",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "supportedLanguages":{
            "type":"object",
            "description":"Languages that are supported by the company (supported languages are mandatory only for host company updates).",
            "title":"Supported Languages",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/language"
                    }
                }
            }
        },
        "supportedCurrencies":{
            "type":"object",
            "description":"Currencies that are supported by the company.",
            "title":"Supported Currencies",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/currency"
                    }
                }
            }
        },
        "styleSheets":{
            "type":"object",
            "description":"StyleSheets of the company.",
            "title":"Style Sheets",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/companyStyleSheet-collection"
                    }
                }
            }
        },
        "translations":{
            "type":"object",
            "description":"Translations of the company.",
            "title":"Translations",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/companyTranslation-collection"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Company Details"
}

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

{
    "type":"object",
    "description":"Base currency of the company. Value holds currency code.",
    "title":"Currency",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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

{
    "type":"object",
    "description":"Base language of the company. Value holds the language code.",
    "title":"Base Language",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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.

{
    "type":"object",
    "description":"Company preferred date time format.",
    "title":"Date/Time Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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.

{
    "type":"object",
    "description":"Preferred number format of the company.",
    "title":"Number Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Style Sheets

Type: object

Title: Style Sheets

StyleSheets of the company.

Show Source

• items: array items

{
    "type":"object",
    "description":"StyleSheets of the company.",
    "title":"Style Sheets",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/companyStyleSheet-collection"
            }
        }
    }
}

Nested Schema : Supported Currencies

Type: object

Title: Supported Currencies

Currencies that are supported by the company.

Show Source

• items: array items

{
    "type":"object",
    "description":"Currencies that are supported by the company.",
    "title":"Supported Currencies",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/currency"
            }
        }
    }
}

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

• items: array items

{
    "type":"object",
    "description":"Languages that are supported by the company (supported languages are mandatory only for host company updates).",
    "title":"Supported Languages",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/language"
            }
        }
    }
}

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.

{
    "type":"object",
    "description":"Company preferred timezone.",
    "title":"TimeZone of the company",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Translations

Type: object

Title: Translations

Translations of the company.

Show Source

• items: array items

{
    "type":"object",
    "description":"Translations of the company.",
    "title":"Translations",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/companyTranslation-collection"
            }
        }
    }
}

Nested Schema : Units

Type: object

Title: Units

Company preferred units.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Company preferred units.",
    "title":"Units",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : items

Type: array

Show Source

• Array of: object companyStyleSheet-collection

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/companyStyleSheet-collection"
    }
}

Nested Schema : companyStyleSheet-collection

Type: object

Show Source

• items: array Style Sheet Collection
  Title: Style Sheet Collection

  List of style sheets.
• links: array Links
  Title: Links

  Links to current objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of style sheets.",
            "title":"Style Sheet Collection",
            "items":{
                "$ref":"#/definitions/companyStyleSheet"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

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

{
    "type":"array",
    "description":"List of style sheets.",
    "title":"Style Sheet Collection",
    "items":{
        "$ref":"#/definitions/companyStyleSheet"
    }
}

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

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Style Sheet

Type: object

Title: Style Sheet

Show Source

• links: array Links
  Title: Links

  Links to current objects.
• name: string
  Title: Style Sheet Name

  Unique name for the style sheet.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Unique name for the style sheet.",
            "title":"Style Sheet Name"
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "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

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Currency Details
  Title: Currency Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/currency"
    }
}

Nested Schema : Currency Details

Type: object

Title: Currency Details

Show Source

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

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string",
            "description":"Currency code.",
            "title":"Currency Code"
        },
        "currencyName":{
            "type":"string",
            "description":"Currency name.",
            "title":"Currency Name"
        },
        "precision":{
            "type":"integer",
            "description":"Precision value.",
            "title":"Precision Value"
        },
        "isBaseCurrency":{
            "type":"boolean",
            "description":"Is base currency?",
            "title":"Is Base Currency"
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Is enabled?",
            "title":"Is Enabled"
        }
    },
    "title":"Currency Details"
}

Nested Schema : items

Type: array

Show Source

• Array of: object language

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/language"
    }
}

Nested Schema : language

Type: object

Show Source

• languageCode: string
  Title: Language Code

  Language Code
• languageNumber: integer
  Title: Language Number

  Unique language number.

{
    "type":"object",
    "properties":{
        "languageCode":{
            "$ref":"#/definitions/languageCode"
        },
        "languageNumber":{
            "type":"integer",
            "description":"Unique language number.",
            "title":"Language Number"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Company Translations
  Title: Company Translations

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/companyTranslation-collection"
    }
}

Nested Schema : Company Translations

Type: object

Title: Company Translations

Show Source

• items: array Company Translations List
  Title: Company Translations List
• links: array Links
  Title: Links

  Links to current objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "title":"Company Translations List",
            "items":{
                "$ref":"#/definitions/companyTranslation"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Company Translations"
}

Nested Schema : Company Translations List

Type: array

Title: Company Translations List

Show Source

• Array of: object Company Translation
  Title: Company Translation

{
    "type":"array",
    "title":"Company Translations List",
    "items":{
        "$ref":"#/definitions/companyTranslation"
    }
}

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

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Company Translation

Type: object

Title: Company Translation

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Company translation name in specific language.",
            "title":"Company Translation Name"
        },
        "language":{
            "type":"object",
            "title":"Translation Language",
            "properties":{
                "languageCode":{
                    "type":"string",
                    "description":"Translation message language name.",
                    "title":"Language Code"
                },
                "languageNumber":{
                    "type":"string",
                    "description":"Language sequence number in supported language list.",
                    "title":"Language Number"
                },
                "links":{
                    "type":"array",
                    "description":"Links to current objects.",
                    "title":"Links",
                    "items":{
                        "$ref":"#/definitions/link"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Company Translation"
}

Nested Schema : Translation Language

Type: object

Title: Translation Language

Show Source

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

{
    "type":"object",
    "title":"Translation Language",
    "properties":{
        "languageCode":{
            "type":"string",
            "description":"Translation message language name.",
            "title":"Language Code"
        },
        "languageNumber":{
            "type":"string",
            "description":"Language sequence number in supported language list.",
            "title":"Language Number"
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

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

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Back to Top

Examples

The following example shows how to replace specific host company or partner organization details with that specified in the web services request by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/companies/visionServices

Request Body Sample

{
  "maximumUser": 20,
  "access": "denied"
}

Response Body Sample

{
  "name": "Vision Services",
  "login": "visionServices",
  "subscriptionPlan": "FullAccessWithESales",
  "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": "[e-mail]",
  "maximumUser": 20,
  "access": "denied" "supportedLanguages": {
    "items": [{
        "languageCode": "ar_SA",
        "languageName": "Arabic [Saudi Arabia]",
        "iso2LanguageCode": "ar",
        "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
      }
    ]
  },
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/companies/visionServices"
    }, {
      "rel": "child",
      "name": "styleSheets",
      "href": "http://sitename.oracle.com/rest/v19/companies/visionServices/styleSheets"
    }, {
      "rel": "child",
      "name": "users",
      "href": "http://sitename.oracle.com/rest/v19/companies/visionServices/users"
    }
  ]
}

Back to Top