digitaluapi

<back to all web services

PaymentPlanDetailsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/payment_plan_details/{Id}
import Foundation
import ServiceStack

// @DataContract
public class PaymentPlanDetailsEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var paymentPlansId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var plannedDate:Date

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var plannedAmount:Double

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var plannedCurrenciesId:Int

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var paymentsId:Int

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public var statusCodesId:Int

    required public init(){}
}

public class PaymentPlanDetailsEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var paymentPlansId:Int

    // @DataMember(Order=3)
    public var plannedDate:Date

    // @DataMember(Order=4)
    public var plannedAmount:Double

    // @DataMember(Order=5)
    public var plannedCurrenciesId:Int

    // @DataMember(Order=6)
    public var paymentsId:Int

    // @DataMember(Order=7)
    public var statusCodesId:Int

    // @DataMember(Order=9)
    public var responseStatus:ResponseStatus

    required public init(){}
}

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

<PaymentPlanDetailsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <PaymentPlansId>0</PaymentPlansId>
  <PlannedDate>0001-01-01T00:00:00</PlannedDate>
  <PlannedAmount>0</PlannedAmount>
  <PlannedCurrenciesId>0</PlannedCurrenciesId>
  <PaymentsId>0</PaymentsId>
  <StatusCodesId>0</StatusCodesId>
</PaymentPlanDetailsEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentPlanDetailsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <PaymentPlansId>0</PaymentPlansId>
  <PaymentsId>0</PaymentsId>
  <PlannedAmount>0</PlannedAmount>
  <PlannedCurrenciesId>0</PlannedCurrenciesId>
  <PlannedDate>0001-01-01T00:00:00</PlannedDate>
  <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>
  <StatusCodesId>0</StatusCodesId>
</PaymentPlanDetailsEditResponse>