POST Customer/get

Get a Customer by CustomerID.

Request Information

URI Parameters

None.

Body Parameters

GetCustomerRequest
NameDescriptionTypeAdditional information
customerID

Customer ID for the requested customer

integer

Required

token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "customerID": 1,
  "token": "f8b52555-18de-4b88-ab13-3b54b08ddff4"
}

application/xml, text/xml

Sample:
<GetCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Customer">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">f8b52555-18de-4b88-ab13-3b54b08ddff4</token>
  <customerID>1</customerID>
</GetCustomerRequest>

Response Information

Resource Description

GetCustomerResponse
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

Customer

Customer's data

CustomerItem

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Customer": {
    "CustomerID": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "CompanyName": "sample string 5",
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "ZipCode": "sample string 10",
    "HomePhone": "sample string 11",
    "WorkPhone": "sample string 12",
    "CellPhone": "sample string 13",
    "Email": "sample string 14"
  },
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<GetCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Customer">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <Customer>
    <Address>sample string 6</Address>
    <Address2>sample string 7</Address2>
    <CellPhone>sample string 13</CellPhone>
    <City>sample string 8</City>
    <CompanyName>sample string 5</CompanyName>
    <CustomerID>1</CustomerID>
    <Email>sample string 14</Email>
    <FirstName>sample string 2</FirstName>
    <HomePhone>sample string 11</HomePhone>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <State>sample string 9</State>
    <WorkPhone>sample string 12</WorkPhone>
    <ZipCode>sample string 10</ZipCode>
  </Customer>
</GetCustomerResponse>