Reference for https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Customer.List
Get a list of customers
Url: https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Customer.List
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:
<CustomerListRequest xmlns="http://api.rivhit.co.il">
<api_token>String content</api_token>
<customer_type>2147483647</customer_type>
<role_id>2147483647</role_id>
<crm_user_id>2147483647</crm_user_id>
<agent_id>2147483647</agent_id>
<filter_fields>
<DynamicFilterFieldsDTO xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<filter_field>String content</filter_field>
<filter_value>String content</filter_value>
</DynamicFilterFieldsDTO>
<DynamicFilterFieldsDTO xmlns="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO">
<filter_field>String content</filter_field>
<filter_value>String content</filter_value>
</DynamicFilterFieldsDTO>
</filter_fields>
<created_after>String content</created_after>
</CustomerListRequest>
The following is an example request Json body:
{
"api_token":"String content",
"customer_type":2147483647,
"role_id":2147483647,
"crm_user_id":2147483647,
"agent_id":2147483647,
"filter_fields":[{
"filter_field":"String content",
"filter_value":"String content"
}],
"created_after":"String content"
}
The following is an example response Xml body:
<CustomerListResponse xmlns="http://api.rivhit.co.il">
<error_code>2147483647</error_code>
<client_message>String content</client_message>
<debug_message>String content</debug_message>
<data>
<customer_list>
<Customer>
<customer_id>2147483647</customer_id>
<last_name>String content</last_name>
<first_name>String content</first_name>
<street>String content</street>
<city>String content</city>
<zipcode>String content</zipcode>
<country>String content</country>
<phone>String content</phone>
<phone2>String content</phone2>
<fax>String content</fax>
<email>String content</email>
<id_number>2147483647</id_number>
<vat_number>2147483647</vat_number>
<customer_type>2147483647</customer_type>
<price_list_id>2147483647</price_list_id>
<agent_id>2147483647</agent_id>
<project_id>2147483647</project_id>
<discount_percent>12678967.543233</discount_percent>
<acc_ref>String content</acc_ref>
<exempt_vat>true</exempt_vat>
<comments>String content</comments>
<available_from>String content</available_from>
<available_to>String content</available_to>
<credit_terms>2147483647</credit_terms>
<credit_days>2147483647</credit_days>
<due_date>String content</due_date>
<pob>2147483647</pob>
<pal_code>2147483647</pal_code>
<paying_customer_id>2147483647</paying_customer_id>
<is_registered>true</is_registered>
<balance>12678967.543233</balance>
<currency_id>2147483647</currency_id>
<cc_token>1627aea5-8e0a-4371-9022-9b504344e724</cc_token>
</Customer>
<Customer>
<customer_id>2147483647</customer_id>
<last_name>String content</last_name>
<first_name>String content</first_name>
<street>String content</street>
<city>String content</city>
<zipcode>String content</zipcode>
<country>String content</country>
<phone>String content</phone>
<phone2>String content</phone2>
<fax>String content</fax>
<email>String content</email>
<id_number>2147483647</id_number>
<vat_number>2147483647</vat_number>
<customer_type>2147483647</customer_type>
<price_list_id>2147483647</price_list_id>
<agent_id>2147483647</agent_id>
<project_id>2147483647</project_id>
<discount_percent>12678967.543233</discount_percent>
<acc_ref>String content</acc_ref>
<exempt_vat>true</exempt_vat>
<comments>String content</comments>
<available_from>String content</available_from>
<available_to>String content</available_to>
<credit_terms>2147483647</credit_terms>
<credit_days>2147483647</credit_days>
<due_date>String content</due_date>
<pob>2147483647</pob>
<pal_code>2147483647</pal_code>
<paying_customer_id>2147483647</paying_customer_id>
<is_registered>true</is_registered>
<balance>12678967.543233</balance>
<currency_id>2147483647</currency_id>
<cc_token>1627aea5-8e0a-4371-9022-9b504344e724</cc_token>
</Customer>
</customer_list>
</data>
</CustomerListResponse>
The following is an example response Json body:
{
"error_code":2147483647,
"client_message":"String content",
"debug_message":"String content",
"data":{
"customer_list":[{
"customer_id":2147483647,
"last_name":"String content",
"first_name":"String content",
"street":"String content",
"city":"String content",
"zipcode":"String content",
"country":"String content",
"phone":"String content",
"phone2":"String content",
"fax":"String content",
"email":"String content",
"id_number":2147483647,
"vat_number":2147483647,
"customer_type":2147483647,
"price_list_id":2147483647,
"agent_id":2147483647,
"project_id":2147483647,
"discount_percent":12678967.543233,
"acc_ref":"String content",
"exempt_vat":true,
"comments":"String content",
"available_from":"String content",
"available_to":"String content",
"credit_terms":2147483647,
"credit_days":2147483647,
"due_date":"String content",
"pob":2147483647,
"pal_code":2147483647,
"paying_customer_id":2147483647,
"is_registered":true,
"balance":12678967.543233,
"currency_id":2147483647,
"cc_token":"1627aea5-8e0a-4371-9022-9b504344e724"
}]
}
}
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:import namespace="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" />
<xs:complexType name="CustomerListRequest">
<xs:sequence>
<xs:element name="api_token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customer_type" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="role_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="crm_user_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="agent_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="filter_fields" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/RivhitOnline.Online_DTO" type="q1:ArrayOfDynamicFilterFieldsDTO" />
<xs:element minOccurs="0" name="created_after" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerListRequest" nillable="true" type="tns:CustomerListRequest" />
</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 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="ArrayOfDynamicFilterFieldsDTO">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DynamicFilterFieldsDTO" nillable="true" type="tns:DynamicFilterFieldsDTO" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDynamicFilterFieldsDTO" nillable="true" type="tns:ArrayOfDynamicFilterFieldsDTO" />
<xs:complexType name="DynamicFilterFieldsDTO">
<xs:sequence>
<xs:element minOccurs="0" name="filter_field" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="filter_value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="DynamicFilterFieldsDTO" nillable="true" type="tns:DynamicFilterFieldsDTO" />
</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:ser="http://schemas.microsoft.com/2003/10/Serialization/" 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.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="CustomerListResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:Response">
<xs:sequence>
<xs:element minOccurs="0" name="data" nillable="true" type="tns:CustomerListData" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CustomerListResponse" nillable="true" type="tns:CustomerListResponse" />
<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:complexType name="CustomerListData">
<xs:sequence>
<xs:element minOccurs="0" name="customer_list" nillable="true" type="tns:ArrayOfCustomer" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomerListData" nillable="true" type="tns:CustomerListData" />
<xs:complexType name="ArrayOfCustomer">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Customer" nillable="true" type="tns:Customer" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomer" nillable="true" type="tns:ArrayOfCustomer" />
<xs:complexType name="Customer">
<xs:sequence>
<xs:element minOccurs="0" name="customer_id" type="xs:int" />
<xs:element minOccurs="0" name="last_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="first_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="street" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="city" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="zipcode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="country" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="phone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="phone2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="fax" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="email" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="id_number" type="xs:int" />
<xs:element minOccurs="0" name="vat_number" type="xs:int" />
<xs:element minOccurs="0" name="customer_type" type="xs:int" />
<xs:element minOccurs="0" name="price_list_id" type="xs:int" />
<xs:element minOccurs="0" name="agent_id" type="xs:int" />
<xs:element minOccurs="0" name="project_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="discount_percent" nillable="true" type="xs:decimal" />
<xs:element minOccurs="0" name="acc_ref" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="exempt_vat" type="xs:boolean" />
<xs:element minOccurs="0" name="comments" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="available_from" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="available_to" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="credit_terms" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="credit_days" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="due_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="pob" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="pal_code" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="paying_customer_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="is_registered" type="xs:boolean" />
<xs:element minOccurs="0" name="balance" type="xs:decimal" />
<xs:element minOccurs="0" name="currency_id" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="cc_token" nillable="true" type="ser:guid" />
</xs:sequence>
</xs:complexType>
<xs:element name="Customer" nillable="true" type="tns:Customer" />
</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 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>