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}

export class CustomersEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public UserAuthId?: number;

    // @DataMember(Order=4)
    public SegmentsId: number;

    // @DataMember(Order=5)
    public CompaniesId?: number;

    // @DataMember(Order=6)
    public CurrenciesId?: number;

    // @DataMember(Order=7)
    public Address: string;

    // @DataMember(Order=8)
    public Age?: number;

    // @DataMember(Order=9)
    public City: string;

    // @DataMember(Order=10)
    public ContactNumber: string;

    // @DataMember(Order=11)
    public Email: string;

    // @DataMember(Order=12)
    public EthnicGroup: string;

    // @DataMember(Order=13)
    public FirstName: string;

    // @DataMember(Order=14)
    public Gender: string;

    // @DataMember(Order=15)
    public HomeLanguage: string;

    // @DataMember(Order=16)
    public IdNumber: string;

    // @DataMember(Order=17)
    public LastName: string;

    // @DataMember(Order=18)
    public PostalCode: string;

    // @DataMember(Order=19)
    public Region: string;

    // @DataMember(Order=20)
    public Suburb: string;

    // @DataMember(Order=21)
    public UniqueIdentifier: string;

    // @DataMember(Order=23)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CustomersEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomersEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=3)
    public UserAuthId?: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public SegmentsId: number;

    // @DataMember(Order=5)
    public CompaniesId?: number;

    // @DataMember(Order=6)
    public CurrenciesId?: number;

    // @DataMember(Order=7)
    public Address: string;

    // @DataMember(Order=8)
    public Age?: number;

    // @DataMember(Order=9)
    public City: string;

    // @DataMember(Order=10)
    public ContactNumber: string;

    // @DataMember(Order=11)
    public Email: string;

    // @DataMember(Order=12)
    public EthnicGroup: string;

    // @DataMember(Order=13)
    public FirstName: string;

    // @DataMember(Order=14)
    public Gender: string;

    // @DataMember(Order=15)
    public HomeLanguage: string;

    // @DataMember(Order=16)
    public IdNumber: string;

    // @DataMember(Order=17)
    public LastName: string;

    // @DataMember(Order=18)
    public PostalCode: string;

    // @DataMember(Order=19)
    public Region: string;

    // @DataMember(Order=20)
    public Suburb: string;

    // @DataMember(Order=21)
    public UniqueIdentifier: string;

    public constructor(init?: Partial<CustomersEdit>) { (Object as any).assign(this, init); }
}

TypeScript 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>