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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class CustomersEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long Id = null;

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Integer TenantsId = null;

        @DataMember(Order=3)
        public Integer UserAuthId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Long SegmentsId = null;

        @DataMember(Order=5)
        public Long CompaniesId = null;

        @DataMember(Order=6)
        public Integer CurrenciesId = null;

        @DataMember(Order=7)
        public String Address = null;

        @DataMember(Order=8)
        public Integer Age = null;

        @DataMember(Order=9)
        public String City = null;

        @DataMember(Order=10)
        public String ContactNumber = null;

        @DataMember(Order=11)
        public String Email = null;

        @DataMember(Order=12)
        public String EthnicGroup = null;

        @DataMember(Order=13)
        public String FirstName = null;

        @DataMember(Order=14)
        public String Gender = null;

        @DataMember(Order=15)
        public String HomeLanguage = null;

        @DataMember(Order=16)
        public String IdNumber = null;

        @DataMember(Order=17)
        public String LastName = null;

        @DataMember(Order=18)
        public String PostalCode = null;

        @DataMember(Order=19)
        public String Region = null;

        @DataMember(Order=20)
        public String Suburb = null;

        @DataMember(Order=21)
        public String UniqueIdentifier = null;
        
        public Long getId() { return Id; }
        public CustomersEdit setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public CustomersEdit setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Integer getUserAuthId() { return UserAuthId; }
        public CustomersEdit setUserAuthId(Integer value) { this.UserAuthId = value; return this; }
        public Long getSegmentsId() { return SegmentsId; }
        public CustomersEdit setSegmentsId(Long value) { this.SegmentsId = value; return this; }
        public Long getCompaniesId() { return CompaniesId; }
        public CustomersEdit setCompaniesId(Long value) { this.CompaniesId = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public CustomersEdit setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public String getAddress() { return Address; }
        public CustomersEdit setAddress(String value) { this.Address = value; return this; }
        public Integer getAge() { return Age; }
        public CustomersEdit setAge(Integer value) { this.Age = value; return this; }
        public String getCity() { return City; }
        public CustomersEdit setCity(String value) { this.City = value; return this; }
        public String getContactNumber() { return ContactNumber; }
        public CustomersEdit setContactNumber(String value) { this.ContactNumber = value; return this; }
        public String getEmail() { return Email; }
        public CustomersEdit setEmail(String value) { this.Email = value; return this; }
        public String getEthnicGroup() { return EthnicGroup; }
        public CustomersEdit setEthnicGroup(String value) { this.EthnicGroup = value; return this; }
        public String getFirstName() { return FirstName; }
        public CustomersEdit setFirstName(String value) { this.FirstName = value; return this; }
        public String getGender() { return Gender; }
        public CustomersEdit setGender(String value) { this.Gender = value; return this; }
        public String getHomeLanguage() { return HomeLanguage; }
        public CustomersEdit setHomeLanguage(String value) { this.HomeLanguage = value; return this; }
        public String getIdNumber() { return IdNumber; }
        public CustomersEdit setIdNumber(String value) { this.IdNumber = value; return this; }
        public String getLastName() { return LastName; }
        public CustomersEdit setLastName(String value) { this.LastName = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public CustomersEdit setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getRegion() { return Region; }
        public CustomersEdit setRegion(String value) { this.Region = value; return this; }
        public String getSuburb() { return Suburb; }
        public CustomersEdit setSuburb(String value) { this.Suburb = value; return this; }
        public String getUniqueIdentifier() { return UniqueIdentifier; }
        public CustomersEdit setUniqueIdentifier(String value) { this.UniqueIdentifier = value; return this; }
    }

    public static class CustomersEditResponse
    {
        @DataMember(Order=1)
        public Long Id = null;

        @DataMember(Order=2)
        public Integer TenantsId = null;

        @DataMember(Order=3)
        public Integer UserAuthId = null;

        @DataMember(Order=4)
        public Long SegmentsId = null;

        @DataMember(Order=5)
        public Long CompaniesId = null;

        @DataMember(Order=6)
        public Integer CurrenciesId = null;

        @DataMember(Order=7)
        public String Address = null;

        @DataMember(Order=8)
        public Integer Age = null;

        @DataMember(Order=9)
        public String City = null;

        @DataMember(Order=10)
        public String ContactNumber = null;

        @DataMember(Order=11)
        public String Email = null;

        @DataMember(Order=12)
        public String EthnicGroup = null;

        @DataMember(Order=13)
        public String FirstName = null;

        @DataMember(Order=14)
        public String Gender = null;

        @DataMember(Order=15)
        public String HomeLanguage = null;

        @DataMember(Order=16)
        public String IdNumber = null;

        @DataMember(Order=17)
        public String LastName = null;

        @DataMember(Order=18)
        public String PostalCode = null;

        @DataMember(Order=19)
        public String Region = null;

        @DataMember(Order=20)
        public String Suburb = null;

        @DataMember(Order=21)
        public String UniqueIdentifier = null;

        @DataMember(Order=23)
        public ResponseStatus ResponseStatus = null;
        
        public Long getId() { return Id; }
        public CustomersEditResponse setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public CustomersEditResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Integer getUserAuthId() { return UserAuthId; }
        public CustomersEditResponse setUserAuthId(Integer value) { this.UserAuthId = value; return this; }
        public Long getSegmentsId() { return SegmentsId; }
        public CustomersEditResponse setSegmentsId(Long value) { this.SegmentsId = value; return this; }
        public Long getCompaniesId() { return CompaniesId; }
        public CustomersEditResponse setCompaniesId(Long value) { this.CompaniesId = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public CustomersEditResponse setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public String getAddress() { return Address; }
        public CustomersEditResponse setAddress(String value) { this.Address = value; return this; }
        public Integer getAge() { return Age; }
        public CustomersEditResponse setAge(Integer value) { this.Age = value; return this; }
        public String getCity() { return City; }
        public CustomersEditResponse setCity(String value) { this.City = value; return this; }
        public String getContactNumber() { return ContactNumber; }
        public CustomersEditResponse setContactNumber(String value) { this.ContactNumber = value; return this; }
        public String getEmail() { return Email; }
        public CustomersEditResponse setEmail(String value) { this.Email = value; return this; }
        public String getEthnicGroup() { return EthnicGroup; }
        public CustomersEditResponse setEthnicGroup(String value) { this.EthnicGroup = value; return this; }
        public String getFirstName() { return FirstName; }
        public CustomersEditResponse setFirstName(String value) { this.FirstName = value; return this; }
        public String getGender() { return Gender; }
        public CustomersEditResponse setGender(String value) { this.Gender = value; return this; }
        public String getHomeLanguage() { return HomeLanguage; }
        public CustomersEditResponse setHomeLanguage(String value) { this.HomeLanguage = value; return this; }
        public String getIdNumber() { return IdNumber; }
        public CustomersEditResponse setIdNumber(String value) { this.IdNumber = value; return this; }
        public String getLastName() { return LastName; }
        public CustomersEditResponse setLastName(String value) { this.LastName = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public CustomersEditResponse setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getRegion() { return Region; }
        public CustomersEditResponse setRegion(String value) { this.Region = value; return this; }
        public String getSuburb() { return Suburb; }
        public CustomersEditResponse setSuburb(String value) { this.Suburb = value; return this; }
        public String getUniqueIdentifier() { return UniqueIdentifier; }
        public CustomersEditResponse setUniqueIdentifier(String value) { this.UniqueIdentifier = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CustomersEditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java CustomersEdit DTOs

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>