digitaluapi

<back to all web services

CustomersEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/customers/{Id}
CustomersEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
TenantsIdbodyintYes
UserAuthIdbodyint?No
SegmentsIdbodylongYes
CompaniesIdbodylong?No
CurrenciesIdbodyint?No
AddressbodystringNo
Agebodyint?No
CitybodystringNo
ContactNumberbodystringNo
EmailbodystringNo
EthnicGroupbodystringNo
FirstNamebodystringNo
GenderbodystringNo
HomeLanguagebodystringNo
IdNumberbodystringNo
LastNamebodystringNo
PostalCodebodystringNo
RegionbodystringNo
SuburbbodystringNo
UniqueIdentifierbodystringNo
CustomersEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TenantsIdformintNo
UserAuthIdformint?No
SegmentsIdformlongNo
CompaniesIdformlong?No
CurrenciesIdformint?No
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EmailformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
UniqueIdentifierformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /customers/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomersEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <UserAuthId>0</UserAuthId>
  <SegmentsId>0</SegmentsId>
  <CompaniesId>0</CompaniesId>
  <CurrenciesId>0</CurrenciesId>
  <Address>String</Address>
  <Age>0</Age>
  <City>String</City>
  <ContactNumber>String</ContactNumber>
  <Email>String</Email>
  <EthnicGroup>String</EthnicGroup>
  <FirstName>String</FirstName>
  <Gender>String</Gender>
  <HomeLanguage>String</HomeLanguage>
  <IdNumber>String</IdNumber>
  <LastName>String</LastName>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <Suburb>String</Suburb>
  <UniqueIdentifier>String</UniqueIdentifier>
</CustomersEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomersEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Address>String</Address>
  <Age>0</Age>
  <City>String</City>
  <CompaniesId>0</CompaniesId>
  <ContactNumber>String</ContactNumber>
  <CurrenciesId>0</CurrenciesId>
  <Email>String</Email>
  <EthnicGroup>String</EthnicGroup>
  <FirstName>String</FirstName>
  <Gender>String</Gender>
  <HomeLanguage>String</HomeLanguage>
  <Id>0</Id>
  <IdNumber>String</IdNumber>
  <LastName>String</LastName>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SegmentsId>0</SegmentsId>
  <Suburb>String</Suburb>
  <TenantsId>0</TenantsId>
  <UniqueIdentifier>String</UniqueIdentifier>
  <UserAuthId>0</UserAuthId>
</CustomersEditResponse>