BokaMera.API.Host

UpdateVossSubscriptionScheduledChange

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/voss/subscriptions/{SubscriptionId}/scheduledChanges/{Id}	Update voss subscription scheduled change	Update a pending subscription scheduled change in the VOSS System. Already executed scheduled changes cannot be updated.

// @ts-nocheck

export enum TypeEnum
{
    AtSubscriptionBillingPeriodEnd = 'AtSubscriptionBillingPeriodEnd',
    AtBindingPeriodEnd = 'AtBindingPeriodEnd',
}

export enum StatusEnum
{
    Active = 'Active',
    Terminated = 'Terminated',
}

// @DataContract(Name="SubscriptionScheduledChangePackageResult")
export class SubscriptionScheduledChangePackageResult
{
    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="versionId", IsRequired=true)
    public versionId: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

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

// @DataContract(Name="SubscriptionScheduledChangeTierResult")
export class SubscriptionScheduledChangeTierResult
{
    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

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

// @DataContract(Name="SubscriptionScheduledChangePlanResult")
export class SubscriptionScheduledChangePlanResult
{
    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

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

// @DataContract(Name="SubscriptionScheduledChangeSalesInformationResult")
export class SubscriptionScheduledChangeSalesInformationResult
{
    // @DataMember(Name="salesPersonId")
    public salesPersonId: string;

    // @DataMember(Name="salesDepartmentId")
    public salesDepartmentId: string;

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

// @DataContract(Name="SubscriptionScheduledChangeResult")
export class SubscriptionScheduledChangeResult
{
    // @DataMember(Name="type")
    public type: TypeEnum;

    // @DataMember(Name="status", IsRequired=true)
    public status: StatusEnum;

    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="package")
    public package: SubscriptionScheduledChangePackageResult;

    // @DataMember(Name="tier")
    public tier: SubscriptionScheduledChangeTierResult;

    // @DataMember(Name="plan")
    public plan: SubscriptionScheduledChangePlanResult;

    // @DataMember(Name="scheduledDate", IsRequired=true)
    public scheduledDate: string;

    // @DataMember(Name="salesInformation")
    public salesInformation: SubscriptionScheduledChangeSalesInformationResult;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class UpdateVossSubscriptionScheduledChange
{
    /** @description The subscription id */
    // @ApiMember(Description="The subscription id", IsRequired=true)
    public SubscriptionId: string;

    /** @description The subscription scheduled change id */
    // @ApiMember(Description="The subscription scheduled change id", IsRequired=true)
    public Id: string;

    /** @description Controls when the scheduled change will be executed:  <br />AtSubscriptionBillingPeriodEnd - after the currently latest subscription billing period ends  <br />AtBindingPeriodEnd - after the currently latest subscription binding period ends */
    // @ApiMember(Description="Controls when the scheduled change will be executed:  <br />AtSubscriptionBillingPeriodEnd - after the currently latest subscription billing period ends  <br />AtBindingPeriodEnd - after the currently latest subscription binding period ends", IsRequired=true)
    public Type: TypeEnum;

    /** @description Optional package version id; if omitted the current version of the subscription package is used */
    // @ApiMember(Description="Optional package version id; if omitted the current version of the subscription package is used")
    public VersionId?: string;

    /** @description The id of a package which will be active after the scheduled change is executed; if provided the tier id and plan id have to be provided as well */
    // @ApiMember(Description="The id of a package which will be active after the scheduled change is executed; if provided the tier id and plan id have to be provided as well")
    public PackageId?: string;

    /** @description The id of a tier which will be active after the scheduled change is executed; can be omitted if PlanId is provided instead */
    // @ApiMember(Description="The id of a tier which will be active after the scheduled change is executed; can be omitted if PlanId is provided instead")
    public TierId?: string;

    /** @description The id of a plan which will be active after the scheduled change is executed; can be omitted if TierId is provided instead */
    // @ApiMember(Description="The id of a plan which will be active after the scheduled change is executed; can be omitted if TierId is provided instead")
    public PlanId?: string;

    /** @description How many periods (counting from the latest period) must pass before the scheduled change is executed; if omitted the change is executed on the latest period end */
    // @ApiMember(Description="How many periods (counting from the latest period) must pass before the scheduled change is executed; if omitted the change is executed on the latest period end")
    public PeriodIterationCount?: number;

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

TypeScript UpdateVossSubscriptionScheduledChange 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 /voss/subscriptions/{SubscriptionId}/scheduledChanges/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVossSubscriptionScheduledChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <PackageId>00000000-0000-0000-0000-000000000000</PackageId>
  <PeriodIterationCount>0</PeriodIterationCount>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <TierId>00000000-0000-0000-0000-000000000000</TierId>
  <Type>AtSubscriptionBillingPeriodEnd</Type>
  <VersionId>00000000-0000-0000-0000-000000000000</VersionId>
</UpdateVossSubscriptionScheduledChange>

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

<SubscriptionScheduledChangeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <id>00000000-0000-0000-0000-000000000000</id>
  <package i:nil="true" />
  <plan i:nil="true" />
  <salesInformation i:nil="true" />
  <scheduledDate>0001-01-01T00:00:00</scheduledDate>
  <status>Pending</status>
  <tier i:nil="true" />
  <type>AtSubscriptionBillingPeriodEnd</type>
</SubscriptionScheduledChangeResult>