POST api/Customer

Create Customer

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerID	integer	None.
CustomerCode	string	Required
FirstName	string	Required
LastName	string	None.
EmailID	string	None.
Address1	string	Required
Address2	string	None.
CityID	integer	None.
CountryID	integer	None.
ProvinceID	integer	None.
CurrencyID	integer	None.
LocationID	integer	None.
ZipCode	string	None.
CompanyName	string	None.
IsActive	integer	None.
PhoneNo	string	None.
SageAccountGroupID	integer	None.
SageAccountID	integer	None.
SagePaymentTermID	integer	None.
SageGLGroupID	integer	None.
LoginUserName	string	None.
LoginPassword	string	None.
EncryptedSalt	string	None.
EncryptedPassword	string	None.
ShipToAddress1	string	None.
ShipToAddress2	string	None.
ShipToCityID	integer	None.
ShipToCountryID	integer	None.
ShipToProvinceID	integer	None.
ShipToLocationID	integer	None.
ShipToZipCode	string	None.
UserID	integer	None.
DCRMRefNo	string	None.
IsSyncFromDreamzCRM	boolean	None.
APIKey	string	None.
PhoneCode	string	None.
WhatsappPhoneCode	string	None.
WhatsappNo	string	None.
IsCustomerPanelAccessEnable	boolean	None.
IsSMSEnable	boolean	None.
IsWhatsAppIncomingEnable	boolean	None.
IsWhatsAppOutgoingEnable	boolean	None.
CustomerType	integer	None.
CustomerServiceAddress	Collection of CustomerServiceAddressRequestDataModel	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "customerID": 1,
  "customerCode": "sample string 1",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "emailID": "sample string 4",
  "address1": "sample string 5",
  "address2": "sample string 6",
  "cityID": 1,
  "countryID": 1,
  "provinceID": 1,
  "currencyID": 1,
  "locationID": 1,
  "zipCode": "sample string 7",
  "companyName": "sample string 8",
  "isActive": 9,
  "phoneNo": "sample string 10",
  "sageAccountGroupID": 1,
  "sageAccountID": 1,
  "sagePaymentTermID": 11,
  "sageGLGroupID": 12,
  "loginUserName": "sample string 13",
  "loginPassword": "sample string 14",
  "encryptedSalt": "sample string 15",
  "encryptedPassword": "sample string 16",
  "shipToAddress1": "sample string 17",
  "shipToAddress2": "sample string 18",
  "shipToCityID": 1,
  "shipToCountryID": 1,
  "shipToProvinceID": 1,
  "shipToLocationID": 1,
  "shipToZipCode": "sample string 19",
  "userID": 20,
  "dcrmRefNo": "sample string 21",
  "isSyncFromDreamzCRM": true,
  "apiKey": "sample string 22",
  "phoneCode": "sample string 23",
  "whatsappPhoneCode": "sample string 24",
  "whatsappNo": "sample string 25",
  "isCustomerPanelAccessEnable": true,
  "isSMSEnable": true,
  "isWhatsAppIncomingEnable": true,
  "isWhatsAppOutgoingEnable": true,
  "customerType": 1,
  "customerServiceAddress": [
    {
      "serviceAddressID": 1,
      "servicePerson1FirstName": "sample string 2",
      "servicePerson1LastName": "sample string 3",
      "servicePerson1Email": "sample string 4",
      "servicePerson1PhoneCode": "sample string 5",
      "servicePerson1PhoneNumber": "sample string 6",
      "servicePerson2FirstName": "sample string 7",
      "servicePerson2LastName": "sample string 8",
      "servicePerson2Email": "sample string 9",
      "servicePerson2PhoneCode": "sample string 10",
      "servicePerson2PhoneNumber": "sample string 11",
      "servicePerson3FirstName": "sample string 12",
      "servicePerson3LastName": "sample string 13",
      "servicePerson3Email": "sample string 14",
      "servicePerson3PhoneCode": "sample string 15",
      "servicePerson3PhoneNumber": "sample string 16",
      "propertyName": "sample string 17",
      "address": "sample string 18",
      "unit": "sample string 19",
      "crossStreet1": "sample string 20",
      "crossStreet2": "sample string 21",
      "emailID": "sample string 22",
      "multipleEmails": "sample string 23",
      "countryID": 1,
      "country": "sample string 24",
      "stateID": 1,
      "state": "sample string 25",
      "cityID": 1,
      "city": "sample string 26",
      "zipCode": "sample string 27",
      "adminNote": "sample string 28",
      "isMailSendOption": 1
    },
    {
      "serviceAddressID": 1,
      "servicePerson1FirstName": "sample string 2",
      "servicePerson1LastName": "sample string 3",
      "servicePerson1Email": "sample string 4",
      "servicePerson1PhoneCode": "sample string 5",
      "servicePerson1PhoneNumber": "sample string 6",
      "servicePerson2FirstName": "sample string 7",
      "servicePerson2LastName": "sample string 8",
      "servicePerson2Email": "sample string 9",
      "servicePerson2PhoneCode": "sample string 10",
      "servicePerson2PhoneNumber": "sample string 11",
      "servicePerson3FirstName": "sample string 12",
      "servicePerson3LastName": "sample string 13",
      "servicePerson3Email": "sample string 14",
      "servicePerson3PhoneCode": "sample string 15",
      "servicePerson3PhoneNumber": "sample string 16",
      "propertyName": "sample string 17",
      "address": "sample string 18",
      "unit": "sample string 19",
      "crossStreet1": "sample string 20",
      "crossStreet2": "sample string 21",
      "emailID": "sample string 22",
      "multipleEmails": "sample string 23",
      "countryID": 1,
      "country": "sample string 24",
      "stateID": 1,
      "state": "sample string 25",
      "cityID": 1,
      "city": "sample string 26",
      "zipCode": "sample string 27",
      "adminNote": "sample string 28",
      "isMailSendOption": 1
    }
  ]
}

application/xml, text/xml

Sample:

<CustomerInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <APIKey>sample string 22</APIKey>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <CityID>1</CityID>
  <CompanyName>sample string 8</CompanyName>
  <CountryID>1</CountryID>
  <CurrencyID>1</CurrencyID>
  <CustomerCode>sample string 1</CustomerCode>
  <CustomerID>1</CustomerID>
  <CustomerServiceAddress>
    <CustomerServiceAddressRequestDataModel>
      <Address>sample string 18</Address>
      <AdminNote>sample string 28</AdminNote>
      <City>sample string 26</City>
      <CityID>1</CityID>
      <Country>sample string 24</Country>
      <CountryID>1</CountryID>
      <CrossStreet1>sample string 20</CrossStreet1>
      <CrossStreet2>sample string 21</CrossStreet2>
      <EmailID>sample string 22</EmailID>
      <IsMailSendOption>1</IsMailSendOption>
      <MultipleEmails>sample string 23</MultipleEmails>
      <PropertyName>sample string 17</PropertyName>
      <ServiceAddressID>1</ServiceAddressID>
      <ServicePerson1Email>sample string 4</ServicePerson1Email>
      <ServicePerson1FirstName>sample string 2</ServicePerson1FirstName>
      <ServicePerson1LastName>sample string 3</ServicePerson1LastName>
      <ServicePerson1PhoneCode>sample string 5</ServicePerson1PhoneCode>
      <ServicePerson1PhoneNumber>sample string 6</ServicePerson1PhoneNumber>
      <ServicePerson2Email>sample string 9</ServicePerson2Email>
      <ServicePerson2FirstName>sample string 7</ServicePerson2FirstName>
      <ServicePerson2LastName>sample string 8</ServicePerson2LastName>
      <ServicePerson2PhoneCode>sample string 10</ServicePerson2PhoneCode>
      <ServicePerson2PhoneNumber>sample string 11</ServicePerson2PhoneNumber>
      <ServicePerson3Email>sample string 14</ServicePerson3Email>
      <ServicePerson3FirstName>sample string 12</ServicePerson3FirstName>
      <ServicePerson3LastName>sample string 13</ServicePerson3LastName>
      <ServicePerson3PhoneCode>sample string 15</ServicePerson3PhoneCode>
      <ServicePerson3PhoneNumber>sample string 16</ServicePerson3PhoneNumber>
      <State>sample string 25</State>
      <StateID>1</StateID>
      <Unit>sample string 19</Unit>
      <ZipCode>sample string 27</ZipCode>
    </CustomerServiceAddressRequestDataModel>
    <CustomerServiceAddressRequestDataModel>
      <Address>sample string 18</Address>
      <AdminNote>sample string 28</AdminNote>
      <City>sample string 26</City>
      <CityID>1</CityID>
      <Country>sample string 24</Country>
      <CountryID>1</CountryID>
      <CrossStreet1>sample string 20</CrossStreet1>
      <CrossStreet2>sample string 21</CrossStreet2>
      <EmailID>sample string 22</EmailID>
      <IsMailSendOption>1</IsMailSendOption>
      <MultipleEmails>sample string 23</MultipleEmails>
      <PropertyName>sample string 17</PropertyName>
      <ServiceAddressID>1</ServiceAddressID>
      <ServicePerson1Email>sample string 4</ServicePerson1Email>
      <ServicePerson1FirstName>sample string 2</ServicePerson1FirstName>
      <ServicePerson1LastName>sample string 3</ServicePerson1LastName>
      <ServicePerson1PhoneCode>sample string 5</ServicePerson1PhoneCode>
      <ServicePerson1PhoneNumber>sample string 6</ServicePerson1PhoneNumber>
      <ServicePerson2Email>sample string 9</ServicePerson2Email>
      <ServicePerson2FirstName>sample string 7</ServicePerson2FirstName>
      <ServicePerson2LastName>sample string 8</ServicePerson2LastName>
      <ServicePerson2PhoneCode>sample string 10</ServicePerson2PhoneCode>
      <ServicePerson2PhoneNumber>sample string 11</ServicePerson2PhoneNumber>
      <ServicePerson3Email>sample string 14</ServicePerson3Email>
      <ServicePerson3FirstName>sample string 12</ServicePerson3FirstName>
      <ServicePerson3LastName>sample string 13</ServicePerson3LastName>
      <ServicePerson3PhoneCode>sample string 15</ServicePerson3PhoneCode>
      <ServicePerson3PhoneNumber>sample string 16</ServicePerson3PhoneNumber>
      <State>sample string 25</State>
      <StateID>1</StateID>
      <Unit>sample string 19</Unit>
      <ZipCode>sample string 27</ZipCode>
    </CustomerServiceAddressRequestDataModel>
  </CustomerServiceAddress>
  <CustomerType>1</CustomerType>
  <DCRMRefNo>sample string 21</DCRMRefNo>
  <EmailID>sample string 4</EmailID>
  <EncryptedPassword>sample string 16</EncryptedPassword>
  <EncryptedSalt>sample string 15</EncryptedSalt>
  <FirstName>sample string 2</FirstName>
  <IsActive>9</IsActive>
  <IsCustomerPanelAccessEnable>true</IsCustomerPanelAccessEnable>
  <IsSMSEnable>true</IsSMSEnable>
  <IsSyncFromDreamzCRM>true</IsSyncFromDreamzCRM>
  <IsWhatsAppIncomingEnable>true</IsWhatsAppIncomingEnable>
  <IsWhatsAppOutgoingEnable>true</IsWhatsAppOutgoingEnable>
  <LastName>sample string 3</LastName>
  <LocationID>1</LocationID>
  <LoginPassword>sample string 14</LoginPassword>
  <LoginUserName>sample string 13</LoginUserName>
  <PhoneCode>sample string 23</PhoneCode>
  <PhoneNo>sample string 10</PhoneNo>
  <ProvinceID>1</ProvinceID>
  <SageAccountGroupID>1</SageAccountGroupID>
  <SageAccountID>1</SageAccountID>
  <SageGLGroupID>12</SageGLGroupID>
  <SagePaymentTermID>11</SagePaymentTermID>
  <ShipToAddress1>sample string 17</ShipToAddress1>
  <ShipToAddress2>sample string 18</ShipToAddress2>
  <ShipToCityID>1</ShipToCityID>
  <ShipToCountryID>1</ShipToCountryID>
  <ShipToLocationID>1</ShipToLocationID>
  <ShipToProvinceID>1</ShipToProvinceID>
  <ShipToZipCode>sample string 19</ShipToZipCode>
  <UserID>20</UserID>
  <WhatsappNo>sample string 25</WhatsappNo>
  <WhatsappPhoneCode>sample string 24</WhatsappPhoneCode>
  <ZipCode>sample string 7</ZipCode>
</CustomerInsertUpdateRequestModel>

multipart/form-data

Sample:

<CustomerInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><APIKey>sample string 22</APIKey><Address1>sample string 5</Address1><Address2>sample string 6</Address2><CityID>1</CityID><CompanyName>sample string 8</CompanyName><CountryID>1</CountryID><CurrencyID>1</CurrencyID><CustomerCode>sample string 1</CustomerCode><CustomerID>1</CustomerID><CustomerServiceAddress><CustomerServiceAddressRequestDataModel><Address>sample string 18</Address><AdminNote>sample string 28</AdminNote><City>sample string 26</City><CityID>1</CityID><Country>sample string 24</Country><CountryID>1</CountryID><CrossStreet1>sample string 20</CrossStreet1><CrossStreet2>sample string 21</CrossStreet2><EmailID>sample string 22</EmailID><IsMailSendOption>1</IsMailSendOption><MultipleEmails>sample string 23</MultipleEmails><PropertyName>sample string 17</PropertyName><ServiceAddressID>1</ServiceAddressID><ServicePerson1Email>sample string 4</ServicePerson1Email><ServicePerson1FirstName>sample string 2</ServicePerson1FirstName><ServicePerson1LastName>sample string 3</ServicePerson1LastName><ServicePerson1PhoneCode>sample string 5</ServicePerson1PhoneCode><ServicePerson1PhoneNumber>sample string 6</ServicePerson1PhoneNumber><ServicePerson2Email>sample string 9</ServicePerson2Email><ServicePerson2FirstName>sample string 7</ServicePerson2FirstName><ServicePerson2LastName>sample string 8</ServicePerson2LastName><ServicePerson2PhoneCode>sample string 10</ServicePerson2PhoneCode><ServicePerson2PhoneNumber>sample string 11</ServicePerson2PhoneNumber><ServicePerson3Email>sample string 14</ServicePerson3Email><ServicePerson3FirstName>sample string 12</ServicePerson3FirstName><ServicePerson3LastName>sample string 13</ServicePerson3LastName><ServicePerson3PhoneCode>sample string 15</ServicePerson3PhoneCode><ServicePerson3PhoneNumber>sample string 16</ServicePerson3PhoneNumber><State>sample string 25</State><StateID>1</StateID><Unit>sample string 19</Unit><ZipCode>sample string 27</ZipCode></CustomerServiceAddressRequestDataModel><CustomerServiceAddressRequestDataModel><Address>sample string 18</Address><AdminNote>sample string 28</AdminNote><City>sample string 26</City><CityID>1</CityID><Country>sample string 24</Country><CountryID>1</CountryID><CrossStreet1>sample string 20</CrossStreet1><CrossStreet2>sample string 21</CrossStreet2><EmailID>sample string 22</EmailID><IsMailSendOption>1</IsMailSendOption><MultipleEmails>sample string 23</MultipleEmails><PropertyName>sample string 17</PropertyName><ServiceAddressID>1</ServiceAddressID><ServicePerson1Email>sample string 4</ServicePerson1Email><ServicePerson1FirstName>sample string 2</ServicePerson1FirstName><ServicePerson1LastName>sample string 3</ServicePerson1LastName><ServicePerson1PhoneCode>sample string 5</ServicePerson1PhoneCode><ServicePerson1PhoneNumber>sample string 6</ServicePerson1PhoneNumber><ServicePerson2Email>sample string 9</ServicePerson2Email><ServicePerson2FirstName>sample string 7</ServicePerson2FirstName><ServicePerson2LastName>sample string 8</ServicePerson2LastName><ServicePerson2PhoneCode>sample string 10</ServicePerson2PhoneCode><ServicePerson2PhoneNumber>sample string 11</ServicePerson2PhoneNumber><ServicePerson3Email>sample string 14</ServicePerson3Email><ServicePerson3FirstName>sample string 12</ServicePerson3FirstName><ServicePerson3LastName>sample string 13</ServicePerson3LastName><ServicePerson3PhoneCode>sample string 15</ServicePerson3PhoneCode><ServicePerson3PhoneNumber>sample string 16</ServicePerson3PhoneNumber><State>sample string 25</State><StateID>1</StateID><Unit>sample string 19</Unit><ZipCode>sample string 27</ZipCode></CustomerServiceAddressRequestDataModel></CustomerServiceAddress><CustomerType>1</CustomerType><DCRMRefNo>sample string 21</DCRMRefNo><EmailID>sample string 4</EmailID><EncryptedPassword>sample string 16</EncryptedPassword><EncryptedSalt>sample string 15</EncryptedSalt><FirstName>sample string 2</FirstName><IsActive>9</IsActive><IsCustomerPanelAccessEnable>true</IsCustomerPanelAccessEnable><IsSMSEnable>true</IsSMSEnable><IsSyncFromDreamzCRM>true</IsSyncFromDreamzCRM><IsWhatsAppIncomingEnable>true</IsWhatsAppIncomingEnable><IsWhatsAppOutgoingEnable>true</IsWhatsAppOutgoingEnable><LastName>sample string 3</LastName><LocationID>1</LocationID><LoginPassword>sample string 14</LoginPassword><LoginUserName>sample string 13</LoginUserName><PhoneCode>sample string 23</PhoneCode><PhoneNo>sample string 10</PhoneNo><ProvinceID>1</ProvinceID><SageAccountGroupID>1</SageAccountGroupID><SageAccountID>1</SageAccountID><SageGLGroupID>12</SageGLGroupID><SagePaymentTermID>11</SagePaymentTermID><ShipToAddress1>sample string 17</ShipToAddress1><ShipToAddress2>sample string 18</ShipToAddress2><ShipToCityID>1</ShipToCityID><ShipToCountryID>1</ShipToCountryID><ShipToLocationID>1</ShipToLocationID><ShipToProvinceID>1</ShipToProvinceID><ShipToZipCode>sample string 19</ShipToZipCode><UserID>20</UserID><WhatsappNo>sample string 25</WhatsappNo><WhatsappPhoneCode>sample string 24</WhatsappPhoneCode><ZipCode>sample string 7</ZipCode></CustomerInsertUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>