GET api/Client/GetAllClient

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Client
NameDescriptionTypeAdditional information
CustomerCode

integer

None.
CustomerName

string

String length: inclusive between 0 and 100
Address

string

String length: inclusive between 0 and 1500
Email

string

String length: inclusive between 0 and 200
Phone

string

String length: inclusive between 0 and 15
MobileNumber

string

String length: inclusive between 0 and 15
FaxNumber

string

String length: inclusive between 0 and 15
Status

string

String length: inclusive between 0 and 50
IntroducedBy

string

String length: inclusive between 0 and 500
VATNo

string

String length: inclusive between 0 and 100
ClientNameInArabic

string

String length: inclusive between 0 and 500
AddressInArabic

string

String length: inclusive between 0 and 1500
BuildingNumber

string

String length: inclusive between 0 and 100
Street

string

String length: inclusive between 0 and 100
Country

Country

None.
CountryCode

integer

None.
postalCode

integer

None.
AdditionalNumber

string

String length: inclusive between 0 and 100

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerCode": 1,
    "CustomerName": "sample string 2",
    "Address": "sample string 3",
    "Email": "sample string 4",
    "Phone": "sample string 5",
    "MobileNumber": "sample string 6",
    "FaxNumber": "sample string 7",
    "Status": "sample string 8",
    "IntroducedBy": "sample string 9",
    "VATNo": "sample string 10",
    "ClientNameInArabic": "sample string 11",
    "AddressInArabic": "sample string 12",
    "BuildingNumber": "sample string 13",
    "Street": "sample string 14",
    "Country": {
      "CountryCode": 1,
      "CountryName": "sample string 2"
    },
    "CountryCode": 15,
    "postalCode": 16,
    "AdditionalNumber": "sample string 17"
  },
  {
    "CustomerCode": 1,
    "CustomerName": "sample string 2",
    "Address": "sample string 3",
    "Email": "sample string 4",
    "Phone": "sample string 5",
    "MobileNumber": "sample string 6",
    "FaxNumber": "sample string 7",
    "Status": "sample string 8",
    "IntroducedBy": "sample string 9",
    "VATNo": "sample string 10",
    "ClientNameInArabic": "sample string 11",
    "AddressInArabic": "sample string 12",
    "BuildingNumber": "sample string 13",
    "Street": "sample string 14",
    "Country": {
      "CountryCode": 1,
      "CountryName": "sample string 2"
    },
    "CountryCode": 15,
    "postalCode": 16,
    "AdditionalNumber": "sample string 17"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERPAPIV1.Models">
  <Client>
    <AdditionalNumber>sample string 17</AdditionalNumber>
    <Address>sample string 3</Address>
    <AddressInArabic>sample string 12</AddressInArabic>
    <BuildingNumber>sample string 13</BuildingNumber>
    <ClientNameInArabic>sample string 11</ClientNameInArabic>
    <Country>
      <CountryCode>1</CountryCode>
      <CountryName>sample string 2</CountryName>
    </Country>
    <CountryCode>15</CountryCode>
    <CustomerCode>1</CustomerCode>
    <CustomerName>sample string 2</CustomerName>
    <Email>sample string 4</Email>
    <FaxNumber>sample string 7</FaxNumber>
    <IntroducedBy>sample string 9</IntroducedBy>
    <MobileNumber>sample string 6</MobileNumber>
    <Phone>sample string 5</Phone>
    <Status>sample string 8</Status>
    <Street>sample string 14</Street>
    <VATNo>sample string 10</VATNo>
    <postalCode>16</postalCode>
  </Client>
  <Client>
    <AdditionalNumber>sample string 17</AdditionalNumber>
    <Address>sample string 3</Address>
    <AddressInArabic>sample string 12</AddressInArabic>
    <BuildingNumber>sample string 13</BuildingNumber>
    <ClientNameInArabic>sample string 11</ClientNameInArabic>
    <Country>
      <CountryCode>1</CountryCode>
      <CountryName>sample string 2</CountryName>
    </Country>
    <CountryCode>15</CountryCode>
    <CustomerCode>1</CustomerCode>
    <CustomerName>sample string 2</CustomerName>
    <Email>sample string 4</Email>
    <FaxNumber>sample string 7</FaxNumber>
    <IntroducedBy>sample string 9</IntroducedBy>
    <MobileNumber>sample string 6</MobileNumber>
    <Phone>sample string 5</Phone>
    <Status>sample string 8</Status>
    <Street>sample string 14</Street>
    <VATNo>sample string 10</VATNo>
    <postalCode>16</postalCode>
  </Client>
</ArrayOfClient>