getCompanyInfo

Returns information about the specified company including the company handle, the company name, the root path, and the expiration date. You must specify either companyHandle or companyName whose information you want to retrieve.

Syntax

Authorized User Types

IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameters

Input (getCompanyInfoParam)

Name	Type	Required	Description
companyHandle	xsd:string	Either companyHandle or companyName is required.	The handle of the company whose information you want to obtain.
companyName	xsd:string	Either companyHandle or companyName is required.	The name of the company whose information you want to obtain.

Output (getCompanyInfoReturn)

Name	Type	Required	Description
companyInfo	types:Company	Yes	Handle and other descriptive information about the company.

Examples

This code sample returns all information about a company by using a company name and handle. It returns data similar to the response received when creating a company.

Request

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

Response

<ns1:getCompanyInfoReturn 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:getCompanyInfoReturn>