POST api/v1/Agents/{AgentID}/Customers

Here Customer refers to Addressbook, Software agents will create customer(Addressbook) for configured agent.

Request Information

Parameters

NameDescriptionAdditional information
CustomerDTO 
AddressBook DTO

Define this parameter in the request body.
AgentID 
AgentID

Define this parameter in the request URI.

Request body formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample: 
{
  "CustomerID": 1,
  "AccountNumber": "sample string 2",
  "Name": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": {
    "Code": "sample string 1",
    "Name": "sample string 2"
  },
  "StateProvince": "sample string 6",
  "Country": {
    "Code": "sample string 1",
    "Name": "sample string 1 - sample string 2"
  },
  "ZipCode": "sample string 7",
  "Email": "sample string 8",
  "Phone": "sample string 9",
  "Fax": "sample string 10",
  "CustomerVisibility": true,
  "ExternalRefID": "sample string 12",
  "PrintDetails": "sample string 13"
}

application/xml, text/xml

Sample: 
<CustomerDTO>
  <CustomerID>1</CustomerID>
  <AccountNumber>sample string 2</AccountNumber>
  <Name>sample string 3</Name>
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <City>
    <Code>sample string 1</Code>
    <Name>sample string 2</Name>
  </City>
  <StateProvince>sample string 6</StateProvince>
  <Country>
    <Code>sample string 1</Code>
    <Name>sample string 1 - sample string 2</Name>
  </Country>
  <ZipCode>sample string 7</ZipCode>
  <Email>sample string 8</Email>
  <Phone>sample string 9</Phone>
  <Fax>sample string 10</Fax>
  <CustomerVisibility>true</CustomerVisibility>
  <ExternalRefID>sample string 12</ExternalRefID>
  <PrintDetails>sample string 13</PrintDetails>
</CustomerDTO>

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "CustomerID": 1,
  "AccountNumber": "sample string 2",
  "Name": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": {
    "Code": "sample string 1",
    "Name": "sample string 2"
  },
  "StateProvince": "sample string 6",
  "Country": {
    "Code": "sample string 1",
    "Name": "sample string 1 - sample string 2"
  },
  "ZipCode": "sample string 7",
  "Email": "sample string 8",
  "Phone": "sample string 9",
  "Fax": "sample string 10",
  "CustomerVisibility": true,
  "ExternalRefID": "sample string 12",
  "PrintDetails": "sample string 13"
}

application/xml, text/xml

Sample: 
<CustomerDTO>
  <CustomerID>1</CustomerID>
  <AccountNumber>sample string 2</AccountNumber>
  <Name>sample string 3</Name>
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <City>
    <Code>sample string 1</Code>
    <Name>sample string 2</Name>
  </City>
  <StateProvince>sample string 6</StateProvince>
  <Country>
    <Code>sample string 1</Code>
    <Name>sample string 1 - sample string 2</Name>
  </Country>
  <ZipCode>sample string 7</ZipCode>
  <Email>sample string 8</Email>
  <Phone>sample string 9</Phone>
  <Fax>sample string 10</Fax>
  <CustomerVisibility>true</CustomerVisibility>
  <ExternalRefID>sample string 12</ExternalRefID>
  <PrintDetails>sample string 13</PrintDetails>
</CustomerDTO>