Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/CRM.NewLead

Add new lead

Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/CRM.NewLead

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:

<NewLeadRequest xmlns="http://api.rivhit.co.il">
  <address>String content</address>
  <api_token>String content</api_token>
  <close>true</close>
  <crm_user_id>2147483647</crm_user_id>
  <customer_id>2147483647</customer_id>
  <description>String content</description>
  <email>String content</email>
  <id_number>String content</id_number>
  <name>String content</name>
  <path>String content</path>
  <phone>String content</phone>
  <preference_id>2147483647</preference_id>
  <ticket_id>String content</ticket_id>
  <treating_user_id>2147483647</treating_user_id>
  <type_id>2147483647</type_id>
</NewLeadRequest>

The following is an example request Json body:

{
	"address":"String content",
	"api_token":"String content",
	"close":true,
	"crm_user_id":2147483647,
	"customer_id":2147483647,
	"description":"String content",
	"email":"String content",
	"id_number":"String content",
	"name":"String content",
	"path":"String content",
	"phone":"String content",
	"preference_id":2147483647,
	"ticket_id":"String content",
	"treating_user_id":2147483647,
	"type_id":2147483647
}

The following is an example response Xml body:

<NewLeadResponse xmlns="http://api.rivhit.co.il">
  <error_code>2147483647</error_code>
  <client_message>String content</client_message>
  <debug_message>String content</debug_message>
  <data>
    <appointment_id xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">2147483647</appointment_id>
  </data>
</NewLeadResponse>

The following is an example response Json body:

{
	"error_code":2147483647,
	"client_message":"String content",
	"debug_message":"String content",
	"data":{
		"appointment_id":2147483647
	}
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://api.rivhit.co.il" elementFormDefault="qualified" targetNamespace="http://api.rivhit.co.il" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="NewLeadRequest">
    <xs:sequence>
      <xs:element name="address" nillable="true" type="xs:string" />
      <xs:element name="api_token" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="close" type="xs:boolean" />
      <xs:element name="crm_user_id" type="xs:int" />
      <xs:element name="customer_id" type="xs:int" />
      <xs:element name="description" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="email" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="id_number" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="path" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="phone" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="preference_id" nillable="true" type="xs:int" />
      <xs:element minOccurs="0" name="ticket_id" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="treating_user_id" nillable="true" type="xs:int" />
      <xs:element minOccurs="0" name="type_id" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="NewLeadRequest" nillable="true" type="tns:NewLeadRequest" />
</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://api.rivhit.co.il" elementFormDefault="qualified" targetNamespace="http://api.rivhit.co.il" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" />
  <xs:complexType name="NewLeadResponse">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:Response">
        <xs:sequence>
          <xs:element minOccurs="0" name="data" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" type="q1:NewLeadData" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="NewLeadResponse" nillable="true" type="tns:NewLeadResponse" />
  <xs:complexType name="Response">
    <xs:sequence>
      <xs:element minOccurs="0" name="error_code" type="xs:int" />
      <xs:element minOccurs="0" name="client_message" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="debug_message" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Response" nillable="true" type="tns:Response" />
</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/RivhitOnline.Online_DTO" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="NewLeadData">
    <xs:sequence>
      <xs:element minOccurs="0" name="appointment_id" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="NewLeadData" nillable="true" type="tns:NewLeadData" />
</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>