Companies - GetCompanies - Gets a list of companies within the system

Service URL: https://api.learningassistant.com/webservices/soap/company.cfc?wsdl

Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com">
      <id type="xsd:string"> {ID} </id>
      <uuid type="xsd:string"> {UUID} </uuid>
    </authToken>
  </soapenv:Header>
  <soapenv:Body>
    <ns1:GetCompanies soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="https://api.learningassistant.com">
      <CompanyUUID xsi:type="xsd:string"> {CompanyUUID} </CompanyUUID>
      <CompanyName xsi:type="xsd:string"> {CompanyName} </CompanyName>
    </ns1:GetCompanies>
  </soapenv:Body>
</soapenv:Envelope>
Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com">
      <id type="xsd:string"> {ID} </id>
      <uuid type="xsd:string"> {UUID} </uuid>
    </authToken>
  </soapenv:Header>
  <soapenv:Body>
    <ns2:GetCompaniesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
      <GetCompaniesReturn soapenc:arrayType="ns3:Type_company[4]" xmlns:ns3="http://company.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
        <GetCompaniesReturn xsi:type="ns3:Type_company">
          <CompanyAddress xsi:type="xsd:string"> {CompanyAddress} </CompanyAddress>
          <CompanyAddress2 xsi:type="xsd:string"> {CompanyAddress2} </CompanyAddress2>
          <CompanyAddress3 xsi:type="xsd:string"> {CompanyAddress3} </CompanyAddress3>
          <CompanyCity xsi:type="xsd:string"> {CompanyCity} </CompanyCity>
          <CompanyEmailAddress xsi:type="xsd:string"> {CompanyEmailAddress} </CompanyEmailAddress>
          <CompanyName xsi:type="xsd:string"> {CompanyName} </CompanyName>
          <CompanyPostcode xsi:type="xsd:string"> {CompanyPostcode} </CompanyPostcode>
          <CompanyTelephoneNumber xsi:type="xsd:string"> {CompanyTelephoneNumber} </CompanyTelephoneNumber>
          <CompanyUUID xsi:type="xsd:string"> {CompanyUUID} </CompanyUUID>
          <PrimaryContactEmailAddress xsi:type="xsd:string"> {PrimaryContactEmailAddress} </PrimaryContactEmailAddress>
          <PrimaryContactName xsi:type="xsd:string"> {PrimaryContactName} </PrimaryContactName>
          <PrimaryContactTelephoneNumber xsi:type="xsd:string"> {PrimaryContactTelephoneNumber} </PrimaryContactTelephoneNumber>
          <SecondaryContactEmailAddress xsi:type="xsd:string"> {SecondaryContactEmailAddress} </SecondaryContactEmailAddress>
          <SecondaryContactName xsi:type="xsd:string"> {SecondaryContactName} </SecondaryContactName>
          <SecondaryContactTelephoneNumber xsi:type="xsd:string"> {SecondaryContactTelephoneNumber} </SecondaryContactTelephoneNumber>
        </GetCompaniesReturn>
      </GetCompaniesReturn>
    </ns2:GetCompaniesResponse>
  </soapenv:Body>
</soapenv:Envelope>
Request Fields
  • GetCompanies array Required
    Top level field for the GetCompanies request
  • CompanyUUID string Required
    Company uuid
  • CompanyName string Required
    Company name
Response Fields
  • GetCompaniesResponse array
    Top level field for the GetCompanies request
  • CompanyAddress2 string
    Top level field for the GetCompanies request
  • CompanyAddress3 string
    Top level field for the GetCompanies request
  • CompanyCity string
    Top level field for the GetCompanies request
  • CompanyEmailAddress string
    Top level field for the GetCompanies request
  • CompanyName string
    Top level field for the GetCompanies request
  • CompanyPostcode string
    Top level field for the GetCompanies request
  • CompanyTelephoneNumber string
    Top level field for the GetCompanies request
  • CompanyUUID string
    Top level field for the GetCompanies request
  • PrimaryContactEmailAddress string
    Top level field for the GetCompanies request
  • PrimaryContactName string
    Top level field for the GetCompanies request
  • PrimaryContactTelephoneNumber string
    Top level field for the GetCompanies request
  • SecondaryContactEmailAddress string
    Top level field for the GetCompanies request
  • SecondaryContactName string
    Top level field for the GetCompanies request
  • SecondaryContactTelephoneNumber string
    Top level field for the GetCompanies request