A base class for all API DTO classes
| name | data type | description |
|---|---|---|
| subscriptionCode | string | |
| consumer | string | |
| productsToSuspend | array of ServiceToUpdateDto | |
| productsToReactivate | array of ServiceToUpdateDto | |
| productsToTerminate | array of ServiceToUpdateDto | |
| productsToActivate | array of ServiceToUpdateDto | |
| productsToRestart | array of ServiceToUpdateDto |
Example
{
"subscriptionCode" : "...",
"consumer" : "...",
"productsToSuspend" : [ {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "RECURRING",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "DAY",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "MONTH",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"productsToReactivate" : [ {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "CALENDAR",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "DAY",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"productsToTerminate" : [ {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "DAY",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "RECURRING",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"productsToActivate" : [ {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "MONTH",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "RECURRING",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"productsToRestart" : [ {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "RECURRING",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "MONTH",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"id" : 12345,
"code" : "...",
"overrideCode" : "...",
"description" : "...",
"quantity" : 12345.0,
"actionDate" : 12345,
"endAgreementDate" : 12345,
"terminationDate" : 12345,
"terminationReason" : "...",
"serviceRenewal" : {
"initialTermType" : "RECURRING",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ]
}