Net3 API Interface for Customer Portal

<back to all web services

Companies

Retrieve Company information.

Requires Authentication
The following routes are available for this service:
POST/companiesOLD
Companies Parameters:
NameParameterData TypeRequiredDescription
secretbodystringNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
CompaniesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TypeCompany>No
ResponseStatusformResponseStatusNo
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /companiesOLD HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Companies xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <sessionId>String</sessionId>
  <secret>String</secret>
</Companies>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:TypeCompany>
      <d2p1:_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_CompanyId_x003E_k__BackingField>
      <d2p1:_x003C_CompanyNameShort_x003E_k__BackingField>String</d2p1:_x003C_CompanyNameShort_x003E_k__BackingField>
      <d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
      <d2p1:_x003C_IsReseller_x003E_k__BackingField>false</d2p1:_x003C_IsReseller_x003E_k__BackingField>
      <d2p1:_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ModifiedBy_x003E_k__BackingField>
      <d2p1:_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ModifiedDate_x003E_k__BackingField>
      <d2p1:_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</d2p1:_x003C_TypeCompanyStatusId_x003E_k__BackingField>
      <d2p1:_x003C_Website_x003E_k__BackingField>String</d2p1:_x003C_Website_x003E_k__BackingField>
    </d2p1:TypeCompany>
  </Result>
</CompaniesResponse>