POST api/Contact/Person

Request information over a Contact Person / Login User

Request Information

URI Parameters

None.

Body Parameters

The ContactPersonRequest

ContactPersonRequest
NameDescriptionTypeAdditional information
ContactPersonID

The unique ID of a known contact person, could be blank if the new user just registered at the web application and email address is also already verified.

integer

None.

EMailAddress

The email address of the contact person

string

None.

Password

The password of the contact person

string

None.

RequestType

RequestType 1 is default: don't verify password
RequestType 2: verify password
RequestType 3: set password
If verification fails, ContactPersonID is zero
Verification can fail if email address is unknown or wrong password

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ContactPersonID": 1,
  "EMailAddress": "sample string 2",
  "Password": "sample string 3",
  "RequestType": 4
}

application/xml, text/xml

Sample:
<ContactPersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO">
  <ContactPersonID>1</ContactPersonID>
  <EMailAddress>sample string 2</EMailAddress>
  <Password>sample string 3</Password>
  <RequestType>4</RequestType>
</ContactPersonRequest>

Response Information

Resource Description

ContactPerson

ContactPerson
NameDescriptionTypeAdditional information
ContactPersonID

The unique ID of this contact person
If password verification fails, ContactPersonID is zero

integer

None.

FirstName

First name

string

None.

LastNamePrefix

Prefix of the last name

string

None.

LastName

Last name

string

None.

EMailAddress

Email address of contact person

string

None.

OrganizationID

OrganizationID of contact person

integer

None.

OrganizationName

Organization Name of contact person

string

None.

PermissionSet

Permission Set of contact person Based on this permission set, the contact person (login user) can see more or less products/images

integer

None.

DefaultDeliveryAddress

Default Delivery Address of contact person

Address

None.

DefaultBillingAddress

Default Billing Address of contact person

Address

None.

Response Formats

application/json, text/json

Sample:
{
  "ContactPersonID": 1,
  "FirstName": "sample string 2",
  "LastNamePrefix": "sample string 3",
  "LastName": "sample string 4",
  "EMailAddress": "sample string 5",
  "OrganizationID": 6,
  "OrganizationName": "sample string 7",
  "PermissionSet": 8,
  "DefaultDeliveryAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "ZipCode": "sample string 5",
    "Country": "sample string 6"
  },
  "DefaultBillingAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "ZipCode": "sample string 5",
    "Country": "sample string 6"
  }
}

application/xml, text/xml

Sample:
<ContactPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO">
  <ContactPersonID>1</ContactPersonID>
  <DefaultBillingAddress>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Region>sample string 4</Region>
    <ZipCode>sample string 5</ZipCode>
  </DefaultBillingAddress>
  <DefaultDeliveryAddress>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Region>sample string 4</Region>
    <ZipCode>sample string 5</ZipCode>
  </DefaultDeliveryAddress>
  <EMailAddress>sample string 5</EMailAddress>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 4</LastName>
  <LastNamePrefix>sample string 3</LastNamePrefix>
  <OrganizationID>6</OrganizationID>
  <OrganizationName>sample string 7</OrganizationName>
  <PermissionSet>8</PermissionSet>
</ContactPerson>