Reference for https://api.circuitree.com/Authentication/Authenticate.json

Url: https://api.circuitree.com/Authentication/Authenticate.json

HTTP Method: POST

Message direction	Format	Body
Request	Xml	Example,Schema
Request	Json	Example
Response	Xml	Example,Schema
Response	Json	Example

The following is an example request Xml body:

<AuthenticationParameters xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web">
  <APIKey>String content</APIKey>
  <AuthenticateForEntity>true</AuthenticateForEntity>
  <CompanyCode>String content</CompanyCode>
  <Password>String content</Password>
  <Username>String content</Username>
</AuthenticationParameters>

The following is an example request Json body:

{
	"APIKey":"String content",
	"AuthenticateForEntity":true,
	"CompanyCode":"String content",
	"Password":"String content",
	"Username":"String content"
}

The following is an example response Xml body:

<AuthenticationResult xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web">
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">Unknown</StatusCode>
  <StatusMessage xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">String content</StatusMessage>
  <ApiToken>String content</ApiToken>
  <CompanyAPIURL>String content</CompanyAPIURL>
  <CompanyID>2147483647</CompanyID>
  <CompanyName>String content</CompanyName>
  <CompanyWebsiteURL>String content</CompanyWebsiteURL>
  <EntityID>9223372036854775807</EntityID>
  <FirstName>String content</FirstName>
  <IsAuthentic>true</IsAuthentic>
  <LastName>String content</LastName>
</AuthenticationResult>

The following is an example response Json body:

{
	"StatusCode":0,
	"StatusMessage":"String content",
	"ApiToken":"String content",
	"CompanyAPIURL":"String content",
	"CompanyID":2147483647,
	"CompanyName":"String content",
	"CompanyWebsiteURL":"String content",
	"EntityID":9223372036854775807,
	"FirstName":"String content",
	"IsAuthentic":true,
	"LastName":"String content"
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="AuthenticationParameters">
    <xs:sequence>
      <xs:element minOccurs="0" name="APIKey" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AuthenticateForEntity" type="xs:boolean" />
      <xs:element minOccurs="0" name="CompanyCode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Username" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="AuthenticationParameters" nillable="true" type="tns:AuthenticationParameters" />
</xs:schema>

Additional request Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:complexType name="AuthenticationResult">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" base="q1:BaseResult">
        <xs:sequence>
          <xs:element minOccurs="0" name="ApiToken" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="CompanyAPIURL" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="CompanyID" type="xs:int" />
          <xs:element minOccurs="0" name="CompanyName" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="CompanyWebsiteURL" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="EntityID" type="xs:long" />
          <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="IsAuthentic" type="xs:boolean" />
          <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="AuthenticationResult" nillable="true" type="tns:AuthenticationResult" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CTS.Common" />
  <xs:complexType name="BaseResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="StatusCode" xmlns:q1="http://schemas.datacontract.org/2004/07/CTS.Common" type="q1:Enums.APIStatusCodes" />
      <xs:element minOccurs="0" name="StatusMessage" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseResult" nillable="true" type="tns:BaseResult" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CTS.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CTS.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="Enums.APIStatusCodes">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Unknown" />
      <xs:enumeration value="Success" />
      <xs:enumeration value="InvalidCredentials" />
      <xs:enumeration value="InvalidCompanyCode" />
      <xs:enumeration value="Configuration" />
      <xs:enumeration value="UnexpectedError" />
      <xs:enumeration value="Invalid" />
      <xs:enumeration value="Failed" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="Enums.APIStatusCodes" nillable="true" type="tns:Enums.APIStatusCodes" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>