EditWizardManager

APS Edit Wizard data manager

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "EditWizardManager",
  "id": "http://odin.com/edit-wizard/edit-wizard-management/1.2",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "parseVendorConfiguration": {
      "path": "/parseVendorConfiguration/{appId}",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "appId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "applyWizardData": {
      "path": "/applyWizardData/{appId}",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "appId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "checkWizardData": {
      "path": "/checkWizardData",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "getWizardData": {
      "path": "/getWizardData/{appId}",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "appId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "getServicePlans": {
      "path": "/getServicePlans",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "serviceTemplates": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getDetailedServicePlans": {
      "path": "/getDetailedServicePlans",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "servicePlans": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getServicePlansList": {
      "path": "/getServicePlansList",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "serviceTemplates": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getResourceRates": {
      "path": "/getResourceRates",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "servicePlan": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getBillingData": {
      "path": "/getBillingData",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "resellers": {
          "kind": "query",
          "type": "string"
        },
        "serviceTemplateIds": {
          "kind": "query",
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
parseVendorConfiguration	POST	/parseVendorConfiguration/{appId}		“parseVendorConfiguration” custom operation (POST)
applyWizardData	POST	/applyWizardData/{appId}		“applyWizardData” custom operation (POST)
checkWizardData	POST	/checkWizardData		“checkWizardData” custom operation (GET) Though HTTP method used is POST (to send a payload), the method just validates ConfSync mappings indeed.
getWizardData	GET	/getWizardData/{appId}	Response.	“getWizardData” custom operation (GET) return AIW WD
getServicePlans	GET	/getServicePlans	Service plans list	Return service plans for given service templates
getDetailedServicePlans	GET	/getDetailedServicePlans	Service plans list	Return detailed service plan info for given ids
getServicePlansList	GET	/getServicePlansList	Service plans list	Return service plans for given service templates
getResourceRates	GET	/getResourceRates	Resource rates for given service plans	Return resource rates for given service plans
getBillingData	GET	/getBillingData	Billing specific data	Return billing specific data

parseVendorConfiguration

HTTP Request

POST /aps/2/resources/{aps-id}/parseVendorConfiguration/{appId}

Description

“parseVendorConfiguration” custom operation (POST)

Parameters

PARAMETER	TYPE	DESCRIPTION
appId	String

Returns

applyWizardData

HTTP Request

POST /aps/2/resources/{aps-id}/applyWizardData/{appId}

Description

“applyWizardData” custom operation (POST)

Parameters

PARAMETER	TYPE	DESCRIPTION
appId	String

Returns

checkWizardData

HTTP Request

POST /aps/2/resources/{aps-id}/checkWizardData

Description

“checkWizardData” custom operation (GET) Though HTTP method used is POST (to send a payload), the method just validates ConfSync mappings indeed.

Returns

getWizardData

HTTP Request

GET /aps/2/resources/{aps-id}/getWizardData/{appId}

Description

“getWizardData” custom operation (GET) return AIW WD

Parameters

PARAMETER	TYPE	DESCRIPTION
appId	String

Returns

Response.

getServicePlans

HTTP Request

GET /aps/2/resources/{aps-id}/getServicePlans

Description

Return service plans for given service templates

Parameters

PARAMETER	TYPE	DESCRIPTION
serviceTemplates	String	List of service templates ids

Returns

Service plans list

getDetailedServicePlans

HTTP Request

GET /aps/2/resources/{aps-id}/getDetailedServicePlans

Description

Return detailed service plan info for given ids

Parameters

PARAMETER	TYPE	DESCRIPTION
servicePlans	String

Returns

Service plans list

getServicePlansList

HTTP Request

GET /aps/2/resources/{aps-id}/getServicePlansList

Description

Return service plans for given service templates

Parameters

PARAMETER	TYPE	DESCRIPTION
serviceTemplates	String	List of service templates ids

Returns

Service plans list

getResourceRates

HTTP Request

GET /aps/2/resources/{aps-id}/getResourceRates

Description

Return resource rates for given service plans

Parameters

PARAMETER	TYPE	DESCRIPTION
servicePlan	String

Returns

Resource rates for given service plans

getBillingData

HTTP Request

GET /aps/2/resources/{aps-id}/getBillingData

Description

Return billing specific data

Parameters

PARAMETER	TYPE	DESCRIPTION
resellers	String	List of resellers ids
serviceTemplateIds	String

Returns

Billing specific data

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Initialization Wizard

InitWizardConfig →