POST api/customers/create

Create a new customer with a new random cardnumber

Request Information

URI Parameters

None.

Body Parameters

createcustomerarguments
NameDescriptionTypeAdditional information
cardnumber

The cardnumer to be created for the person, leave empty or null to let the system generate a random cardnumber

string

None.

initials

The Initials of the person

string

None.

firstname

The first name of the person

string

None.

middlename

The middle name of the person

string

None.

name

The last name of the person

string

None.

street

The street name of the customer

string

None.

housenumber

The house number of the customer

string

None.

postalcode

The postal code of the customer

string

None.

city

The city of the customer

string

None.

birthdate

The birthdate of the person, can be null

date

None.

email

The email address of the person

string

None.

marketing

The person has given permision to use the email addres for marketing activities

boolean

None.

mobilephone

The mobile phonenumber

string

None.

licenceplate

The licenceplate

string

None.

password

The password for the customer to login, leave empty if not used

string

None.

Request Formats

application/json, text/json

Sample:
{
  "cardnumber": "sample string 1",
  "initials": "sample string 2",
  "firstname": "sample string 3",
  "middlename": "sample string 4",
  "name": "sample string 5",
  "street": "sample string 6",
  "housenumber": "sample string 7",
  "postalcode": "sample string 8",
  "city": "sample string 9",
  "birthdate": "2024-11-24",
  "email": "sample string 10",
  "marketing": true,
  "mobilephone": "sample string 12",
  "licenceplate": "sample string 13",
  "password": "sample string 14"
}

application/xml, text/xml

Sample:
<createcustomerarguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API">
  <birthdate>2024-11-24T13:03:39.8797478+01:00</birthdate>
  <cardnumber>sample string 1</cardnumber>
  <city>sample string 9</city>
  <email>sample string 10</email>
  <firstname>sample string 3</firstname>
  <housenumber>sample string 7</housenumber>
  <initials>sample string 2</initials>
  <licenceplate>sample string 13</licenceplate>
  <marketing>true</marketing>
  <middlename>sample string 4</middlename>
  <mobilephone>sample string 12</mobilephone>
  <name>sample string 5</name>
  <password>sample string 14</password>
  <postalcode>sample string 8</postalcode>
  <street>sample string 6</street>
</createcustomerarguments>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'createcustomerarguments'.

Response Information

Resource Description

createcustomerresult
NameDescriptionTypeAdditional information
success

Indicates if the action was successfull

boolean

None.

remark

A description regarding the result

string

None.

customer

Returns the created customer object

customer

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "remark": "sample string 2",
  "customer": {
    "externalid": 1,
    "externalpersonid": 2,
    "locationid": 3,
    "location": "sample string 4",
    "cardnumber": "sample string 5",
    "initials": "sample string 6",
    "firstname": "sample string 7",
    "middlename": "sample string 8",
    "name": "sample string 9",
    "street": "sample string 10",
    "housenumber": "sample string 11",
    "postalcode": "sample string 12",
    "city": "sample string 13",
    "birthdate": "2024-11-24",
    "email": "sample string 14",
    "marketing": true,
    "licenceplate": "sample string 16",
    "datemodified": "2024-11-24T13:03:39.8797478+01:00",
    "group": "sample string 18",
    "lastvisit": "2024-11-24T13:03:39.8797478+01:00",
    "lastvisitlocationid": 1,
    "lastvisitlocation": "sample string 20",
    "loyaltypoints": 21.0,
    "balance": 22.0,
    "subscription": true,
    "mobilephone": "sample string 24"
  }
}

application/xml, text/xml

Sample:
<createcustomerresult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API">
  <customer>
    <balance>22</balance>
    <birthdate>2024-11-24T13:03:39.8797478+01:00</birthdate>
    <cardnumber>sample string 5</cardnumber>
    <city>sample string 13</city>
    <datemodified>2024-11-24T13:03:39.8797478+01:00</datemodified>
    <email>sample string 14</email>
    <externalid>1</externalid>
    <externalpersonid>2</externalpersonid>
    <firstname>sample string 7</firstname>
    <group>sample string 18</group>
    <housenumber>sample string 11</housenumber>
    <initials>sample string 6</initials>
    <lastvisit>2024-11-24T13:03:39.8797478+01:00</lastvisit>
    <lastvisitlocation>sample string 20</lastvisitlocation>
    <lastvisitlocationid>1</lastvisitlocationid>
    <licenceplate>sample string 16</licenceplate>
    <location>sample string 4</location>
    <locationid>3</locationid>
    <loyaltypoints>21</loyaltypoints>
    <marketing>true</marketing>
    <middlename>sample string 8</middlename>
    <mobilephone>sample string 24</mobilephone>
    <name>sample string 9</name>
    <postalcode>sample string 12</postalcode>
    <street>sample string 10</street>
    <subscription>true</subscription>
  </customer>
  <remark>sample string 2</remark>
  <success>true</success>
</createcustomerresult>