addCompany

Adds a company to the system.

Sends the name of the company to be added to the system and optionally sends whether the company expires.

When this operation is invoked, the system gets a *companyInfo* type that contains a company handle and descriptive fields. If the company name requested already exists in the system, it throws an ipsApiFault.

Authorized User Types

  • IpsAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (addCompanyParam)

Name

Type

Required

Description

companyName

xsd:string

Yes

The name of the company to add.

expires

xsd:dateTime

No

The expiration date of the company. Provide the time zone with the request for this field. Time zones are adjusted to Central Time.

Output (addCompanyReturn)

Name

Type

Required

Description

companyInfo

xsd:string

Yes

Handle to and name, root path, expiration date, and time of the new company.

Examples

This example demonstrates a request to add a company to the IPS system and the response detailing the information about the added company that is needed to perform other operations.

Request

<ns1:addCompanyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyName>Planetary</ns1:companyName>
</ns1:addCompanyParam>

Response

<ns1:addCompanyReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyInfo>
      <ns1:companyHandle>137</ns1:companyHandle>
      <ns1:name>Planetary</ns1:name>
      <ns1:rootPath>Planetary/</ns1:rootPath>
      <ns1:expires>2101-01-31T23:00:00.030Z</ns1:expires>
   </ns1:companyInfo>
</ns1:addCompanyReturn>

On this page