digitaluapi

<back to all web services

ClientsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/clients/{Id}
import 'package:servicestack/servicestack.dart';

class ClientsEditResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? Id;

    // @DataMember(Order=2)
    int? TenantsId;

    // @DataMember(Order=3)
    int? CompaniesId;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    ClientsEditResponse({this.Id,this.TenantsId,this.CompaniesId,this.ResponseStatus});
    ClientsEditResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        TenantsId = json['TenantsId'];
        CompaniesId = json['CompaniesId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'TenantsId': TenantsId,
        'CompaniesId': CompaniesId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ClientsEditResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class ClientsEdit implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? Id;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? TenantsId;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    int? CompaniesId;

    ClientsEdit({this.Id,this.TenantsId,this.CompaniesId});
    ClientsEdit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        TenantsId = json['TenantsId'];
        CompaniesId = json['CompaniesId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'TenantsId': TenantsId,
        'CompaniesId': CompaniesId
    };

    getTypeName() => "ClientsEdit";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'ClientsEditResponse': TypeInfo(TypeOf.Class, create:() => ClientsEditResponse()),
    'ClientsEdit': TypeInfo(TypeOf.Class, create:() => ClientsEdit()),
});

Dart ClientsEdit 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 /clients/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <CompaniesId>0</CompaniesId>
</ClientsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CompaniesId>0</CompaniesId>
  <Id>0</Id>
  <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>
  <TenantsId>0</TenantsId>
</ClientsEditResponse>