GET Customer/GetCustomer?SearchType={SearchType}&SearchTypeValue={SearchTypeValue}&SearchTerm={SearchTerm}&phoneNumber={phoneNumber}

Returns a list of customers.

Request Information

URI Parameters

Name	Description	Type	Additional Information
SearchType	Either "Location", "Salesperson", or "Classification". (optional)	string	Default value is string.Empty
SearchTypeValue	If "Location" pass in the location selected. If "Salesperson" pass in the salesperson selected. If "Classification" pass in the classification selected. (optional)	string	Default value is string.Empty
SearchTerm	The value to search for. (optional)	string	Default value is string.Empty
phoneNumber	10 numeric values that will be used as a filter for customer's phone1 or phone2	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of customers.

AgvCustomer

Name	Description	Type
Status	0 = Success; 1 = An error occurred; 2 = An error occurred; 3 = Descriptive message; process was successful	string
Message	Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know	string
Count	Number of customers returned	string
Customers	A List of Properties and Values returned for each customer	Collection of clsAPICustomer

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "Customers": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "Address3": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "ZipCode": "sample string 8",
      "County": "sample string 9",
      "Phone1": "sample string 10",
      "Phone2": "sample string 11",
      "Salesperson": "sample string 12",
      "Notes": "sample string 13",
      "Location": "sample string 14",
      "CustomerGUID": "sample string 15",
      "AlternateCustomerIdPrintout": "sample string 16",
      "AlternateCustomerIdSelecting": "sample string 17",
      "FederalPermitList": [
        {
          "CustID": "sample string 1",
          "LineItem": 2,
          "Permit": "sample string 3",
          "ExpDate": "sample string 4"
        },
        {
          "CustID": "sample string 1",
          "LineItem": 2,
          "Permit": "sample string 3",
          "ExpDate": "sample string 4"
        }
      ]
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "Address3": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "ZipCode": "sample string 8",
      "County": "sample string 9",
      "Phone1": "sample string 10",
      "Phone2": "sample string 11",
      "Salesperson": "sample string 12",
      "Notes": "sample string 13",
      "Location": "sample string 14",
      "CustomerGUID": "sample string 15",
      "AlternateCustomerIdPrintout": "sample string 16",
      "AlternateCustomerIdSelecting": "sample string 17",
      "FederalPermitList": [
        {
          "CustID": "sample string 1",
          "LineItem": 2,
          "Permit": "sample string 3",
          "ExpDate": "sample string 4"
        },
        {
          "CustID": "sample string 1",
          "LineItem": 2,
          "Permit": "sample string 3",
          "ExpDate": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer">
  <Count>sample string 3</Count>
  <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.API">
    <d2p1:clsAPICustomer>
      <d2p1:Address1>sample string 3</d2p1:Address1>
      <d2p1:Address2>sample string 4</d2p1:Address2>
      <d2p1:Address3>sample string 5</d2p1:Address3>
      <d2p1:AlternateCustomerIdPrintout>sample string 16</d2p1:AlternateCustomerIdPrintout>
      <d2p1:AlternateCustomerIdSelecting>sample string 17</d2p1:AlternateCustomerIdSelecting>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:County>sample string 9</d2p1:County>
      <d2p1:CustomerGUID>sample string 15</d2p1:CustomerGUID>
      <d2p1:FederalPermitList xmlns:d4p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
        <d4p1:ClsCustomer.ClsCustFedPerm>
          <d4p1:CustID>sample string 1</d4p1:CustID>
          <d4p1:ExpDate>sample string 4</d4p1:ExpDate>
          <d4p1:LineItem>2</d4p1:LineItem>
          <d4p1:Permit>sample string 3</d4p1:Permit>
        </d4p1:ClsCustomer.ClsCustFedPerm>
        <d4p1:ClsCustomer.ClsCustFedPerm>
          <d4p1:CustID>sample string 1</d4p1:CustID>
          <d4p1:ExpDate>sample string 4</d4p1:ExpDate>
          <d4p1:LineItem>2</d4p1:LineItem>
          <d4p1:Permit>sample string 3</d4p1:Permit>
        </d4p1:ClsCustomer.ClsCustFedPerm>
      </d2p1:FederalPermitList>
      <d2p1:ID>sample string 1</d2p1:ID>
      <d2p1:Location>sample string 14</d2p1:Location>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:Phone1>sample string 10</d2p1:Phone1>
      <d2p1:Phone2>sample string 11</d2p1:Phone2>
      <d2p1:Salesperson>sample string 12</d2p1:Salesperson>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:ZipCode>sample string 8</d2p1:ZipCode>
    </d2p1:clsAPICustomer>
    <d2p1:clsAPICustomer>
      <d2p1:Address1>sample string 3</d2p1:Address1>
      <d2p1:Address2>sample string 4</d2p1:Address2>
      <d2p1:Address3>sample string 5</d2p1:Address3>
      <d2p1:AlternateCustomerIdPrintout>sample string 16</d2p1:AlternateCustomerIdPrintout>
      <d2p1:AlternateCustomerIdSelecting>sample string 17</d2p1:AlternateCustomerIdSelecting>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:County>sample string 9</d2p1:County>
      <d2p1:CustomerGUID>sample string 15</d2p1:CustomerGUID>
      <d2p1:FederalPermitList xmlns:d4p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
        <d4p1:ClsCustomer.ClsCustFedPerm>
          <d4p1:CustID>sample string 1</d4p1:CustID>
          <d4p1:ExpDate>sample string 4</d4p1:ExpDate>
          <d4p1:LineItem>2</d4p1:LineItem>
          <d4p1:Permit>sample string 3</d4p1:Permit>
        </d4p1:ClsCustomer.ClsCustFedPerm>
        <d4p1:ClsCustomer.ClsCustFedPerm>
          <d4p1:CustID>sample string 1</d4p1:CustID>
          <d4p1:ExpDate>sample string 4</d4p1:ExpDate>
          <d4p1:LineItem>2</d4p1:LineItem>
          <d4p1:Permit>sample string 3</d4p1:Permit>
        </d4p1:ClsCustomer.ClsCustFedPerm>
      </d2p1:FederalPermitList>
      <d2p1:ID>sample string 1</d2p1:ID>
      <d2p1:Location>sample string 14</d2p1:Location>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:Phone1>sample string 10</d2p1:Phone1>
      <d2p1:Phone2>sample string 11</d2p1:Phone2>
      <d2p1:Salesperson>sample string 12</d2p1:Salesperson>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:ZipCode>sample string 8</d2p1:ZipCode>
    </d2p1:clsAPICustomer>
  </Customers>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvCustomer>