DocumentationDynamic Media Image Production System API

getCompanyInfo getcompanyinfo

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

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 section-74f20fb8602e4f96810795bc4b6f7fdf

  • IpsUser
  • IpsAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters section-7dec8871c89a414c9f066adade1831d8

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 section-3d5342aa7cb34b1fa84d7dea6e16e4aa

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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681