POST api/Customers/GetCustomersList

Request Information

URI Parameters

None.

Body Parameters

SearchCriteriaWithPaging
NameDescriptionTypeAdditional information
SearchCriteria

SearchCriteria

None.

Paging

Paging

None.

Request Formats

application/json, text/json

Sample:
{
  "searchCriteria": {
    "name": "sample string 1",
    "address": "sample string 2",
    "email": "sample string 3",
    "phone": "sample string 4",
    "insuredId": "sample string 5",
    "customerId": "sample string 6"
  },
  "paging": {
    "pageNumber": 1,
    "pageSize": 2
  }
}

application/xml, text/xml

Sample:
<SearchCriteriaWithPaging xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Paging>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
  </Paging>
  <SearchCriteria>
    <Address>sample string 2</Address>
    <CustomerId>sample string 6</CustomerId>
    <Email>sample string 3</Email>
    <InsuredId>sample string 5</InsuredId>
    <Name>sample string 1</Name>
    <Phone>sample string 4</Phone>
  </SearchCriteria>
</SearchCriteriaWithPaging>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerList
NameDescriptionTypeAdditional information
Count

integer

None.

Result

Collection of Customer

None.

Response Formats

application/json, text/json

Sample:
{
  "count": 1,
  "result": [
    {
      "databaseId": "4889e3e3-45c4-4f9b-8e3b-35a214766ce4",
      "commercialName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "type": 0,
      "addressLine1": "sample string 5",
      "addressLine2": "sample string 6",
      "stateNameOrAbbreviation": "sample string 7",
      "city": "sample string 8",
      "zipCode": "sample string 9",
      "eMail": "sample string 10",
      "eMail2": "sample string 11",
      "eMail3": "sample string 12",
      "fax": "sample string 13",
      "phone": "sample string 14",
      "cellPhone": "sample string 15",
      "smsPhone": "sample string 16",
      "description": "sample string 17",
      "active": true,
      "website": "sample string 19",
      "fein": "sample string 20",
      "customerId": "sample string 21",
      "insuredId": "sample string 22"
    },
    {
      "databaseId": "4889e3e3-45c4-4f9b-8e3b-35a214766ce4",
      "commercialName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "type": 0,
      "addressLine1": "sample string 5",
      "addressLine2": "sample string 6",
      "stateNameOrAbbreviation": "sample string 7",
      "city": "sample string 8",
      "zipCode": "sample string 9",
      "eMail": "sample string 10",
      "eMail2": "sample string 11",
      "eMail3": "sample string 12",
      "fax": "sample string 13",
      "phone": "sample string 14",
      "cellPhone": "sample string 15",
      "smsPhone": "sample string 16",
      "description": "sample string 17",
      "active": true,
      "website": "sample string 19",
      "fein": "sample string 20",
      "customerId": "sample string 21",
      "insuredId": "sample string 22"
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Count>1</Count>
  <Result>
    <Customer>
      <Active>true</Active>
      <AddressLine1>sample string 5</AddressLine1>
      <AddressLine2>sample string 6</AddressLine2>
      <CellPhone>sample string 15</CellPhone>
      <City>sample string 8</City>
      <CommercialName>sample string 2</CommercialName>
      <CustomerId>sample string 21</CustomerId>
      <DatabaseId>4889e3e3-45c4-4f9b-8e3b-35a214766ce4</DatabaseId>
      <Description>sample string 17</Description>
      <EMail>sample string 10</EMail>
      <EMail2>sample string 11</EMail2>
      <EMail3>sample string 12</EMail3>
      <FEIN>sample string 20</FEIN>
      <Fax>sample string 13</Fax>
      <FirstName>sample string 3</FirstName>
      <InsuredId>sample string 22</InsuredId>
      <LastName>sample string 4</LastName>
      <Phone>sample string 14</Phone>
      <SmsPhone>sample string 16</SmsPhone>
      <StateNameOrAbbreviation>sample string 7</StateNameOrAbbreviation>
      <Type>Insured</Type>
      <Website>sample string 19</Website>
      <ZipCode>sample string 9</ZipCode>
    </Customer>
    <Customer>
      <Active>true</Active>
      <AddressLine1>sample string 5</AddressLine1>
      <AddressLine2>sample string 6</AddressLine2>
      <CellPhone>sample string 15</CellPhone>
      <City>sample string 8</City>
      <CommercialName>sample string 2</CommercialName>
      <CustomerId>sample string 21</CustomerId>
      <DatabaseId>4889e3e3-45c4-4f9b-8e3b-35a214766ce4</DatabaseId>
      <Description>sample string 17</Description>
      <EMail>sample string 10</EMail>
      <EMail2>sample string 11</EMail2>
      <EMail3>sample string 12</EMail3>
      <FEIN>sample string 20</FEIN>
      <Fax>sample string 13</Fax>
      <FirstName>sample string 3</FirstName>
      <InsuredId>sample string 22</InsuredId>
      <LastName>sample string 4</LastName>
      <Phone>sample string 14</Phone>
      <SmsPhone>sample string 16</SmsPhone>
      <StateNameOrAbbreviation>sample string 7</StateNameOrAbbreviation>
      <Type>Insured</Type>
      <Website>sample string 19</Website>
      <ZipCode>sample string 9</ZipCode>
    </Customer>
  </Result>
</CustomerList>