Net3 API Interface for Customer Portal

<back to all web services

CompanyUsers

Retrieve Users for a Company.

Requires Authentication
The following routes are available for this service:
GET/company/{companyId}/usersGet Users by CompanyId
CompanyUsers Parameters:
NameParameterData TypeRequiredDescription
companyIdpathGuidNo
CompanyUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TypeUser>No
ResponseStatusformResponseStatusNo
TypeUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
FullNameformstringNo
IsActiveformboolNo
CompanyIdformGuid?No
RolesformstringNo
IdformstringNo

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.

GET /company/{companyId}/users HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyUsersResponse 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/N3TEntities.Logins">
    <d2p1:TypeUser>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Roles>String</d2p1:Roles>
      <d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
    </d2p1:TypeUser>
  </Result>
</CompanyUsersResponse>