Get Company Details

Last updated
Save as PDF

getCompanyDetails

This web service returns a Company object. If a company ID is specified, it returns the information for the specified company; otherwise it returns the information for the caller's company.

Company getCompanyDetails(string companyId) throws WSException

companyId: (optional) A string of maximum length 10 that specifies the unique company identifier of the company to retrieve the details for.

Returns a null string on exceptions; otherwise returns a Company object.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- None

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getCompanyDetails>

<companyId>MYCOMPANY</companyId>

</getCompanyDetails>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:getCompanyDetailsResponse xmlns:p431="http://websvcs.omaswebws">

<getCompanyDetailsReturn>

<address>5775 Morehouse Drive</address>

<address2/>

<alertRetention>14</alertRetention>

<city>San Diego</city>

<country>US</country>

<custAcctNo>12345678</custAcctNo>

<custAuxAcctNo>12345679</custAuxAcctNo>

<hubId>1</hubId>

<id>MYCOMPANY</id>

<lockedOut>0</lockedOut>

<name>My Company, Inc.</name>

<obeyDst>1</obeyDst>

<ownAcctNo/>

<ownAuxAcctNo/>

<postalCode>92121</postalCode>

<qspInstance>1</qspInstance>

<reportRetention>7</reportRetention>

<state>CA</state>

<tempUom>F</tempUom>

<timeZone>

<dstLongName>Pacific Daylight Saving Time</dstLongName>

<dstShortName>PDT</dstShortName>

<gmtOffset>GMT-08:00</gmtOffset>

<name>Pacific Time</name>

<stdLongName>Pacific Standard Time</stdLongName>

<stdShortName>PST</stdShortName>

</timeZone>

<timeZonesObserved>US</timeZonesObserved>

<uom>US</uom>

</getCompanyDetailsReturn>

</getCompanyDetailsResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User is not authorized.
005 User cannot retrieve details for specified company.