POST api/update-customer

Request Information

URI Parameters

None.

Body Parameters

CustomerMappers
NameDescriptionTypeAdditional information
Salutation

string

None.

FirstName

string

Required

LastName

string

Required

Email

string

Required

Data type: EmailAddress

PrimaryContact

string

Required

Data type: PhoneNumber

Matching regular expression pattern: ^[0-9]*$

AlternateContact

string

Matching regular expression pattern: ^[0-9]*$

Country

string

Required

Address

string

Required

City

string

Required

StateProvince

string

None.

PostalCode

string

Required

Data type: PostalCode

PreferredContactMethod

string

None.

IsExistingCustomer

boolean

Required

CleanType

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Salutation": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "PrimaryContact": "sample string 5",
  "AlternateContact": "sample string 6",
  "Country": "sample string 7",
  "Address": "sample string 8",
  "City": "sample string 9",
  "StateProvince": "sample string 10",
  "PostalCode": "sample string 11",
  "PreferredContactMethod": "sample string 12",
  "IsExistingCustomer": true,
  "CleanType": "sample string 14"
}

application/xml, text/xml

Sample:
<CustomerMappers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CottageCareOnlinePricing.BAL.ServiceClass">
  <Address>sample string 8</Address>
  <AlternateContact>sample string 6</AlternateContact>
  <City>sample string 9</City>
  <CleanType>sample string 14</CleanType>
  <Country>sample string 7</Country>
  <Email>sample string 4</Email>
  <FirstName>sample string 2</FirstName>
  <IsExistingCustomer>true</IsExistingCustomer>
  <LastName>sample string 3</LastName>
  <PostalCode>sample string 11</PostalCode>
  <PreferredContactMethod>sample string 12</PreferredContactMethod>
  <PrimaryContact>sample string 5</PrimaryContact>
  <Salutation>sample string 1</Salutation>
  <StateProvince>sample string 10</StateProvince>
</CustomerMappers>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
HasError

boolean

None.

HasSuccess

boolean

None.

IsServiceable

boolean

None.

Status

StatusType

None.

MessageTitle

string

None.

Message

string

None.

ExceptionMessage

string

None.

ExceptionStackTrace

string

None.

ResultException

Exception

None.

ResultObject

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultObject": {},
  "HasError": false,
  "HasSuccess": true,
  "IsServiceable": true,
  "Status": 200,
  "MessageTitle": "sample string 4",
  "Message": "sample string 5",
  "ExceptionMessage": "sample string 6",
  "ExceptionStackTrace": "sample string 7",
  "ResultException": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CottageCare.BAL.ServiceClass">
  <ExceptionMessage>sample string 6</ExceptionMessage>
  <ExceptionStackTrace>sample string 7</ExceptionStackTrace>
  <HasError>false</HasError>
  <HasSuccess>true</HasSuccess>
  <IsServiceable>true</IsServiceable>
  <Message>sample string 5</Message>
  <MessageTitle>sample string 4</MessageTitle>
  <ResultException xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </ResultException>
  <ResultObject />
  <Status>Success</Status>
</Result>