InviteCustomerOptions

This resource returns a list of usage packages available to the user. A usage package is a combination of campaign, prototype and resource package, all of which are necessary to use an environment. Using information in this list, the user can request an invitation to use an environment, and send this information to another user.

If no parameters are included in the request, all usage packages available to the user are returned. If values for campaign, prototype and/or resource are included, the returned list will be filtered accordingly.

Request URL

GET https://use.cloudshare.com/Api/v1/Admin/InviteCustomerOptions?campaignFilter=<campaign>&prototypeFilter=<prototype>&resourceFilter=<resource>&timestamp=<time_t>&UserApiId=<id>&HMAC=<signature>

Parameters

campaignFilter A name of a specific campaign, to filter the result list.
Example: Automation
prototypeFilter A name of a specific prototype, to filter the result list.
Example: automation
resourcePackageFilter A name of a specific resource package, to filter the result list.
Example: Automation

Response example

{
    "json": {
        "AvailableOwningSEsList": [
            {
                "Email": "aaa@aa.com",
                "Name": "aaa aa",
                "Organizations": [
                    "CloudShare"
                ],
                "OwningSEId": "HRTXHOTFTOYB"
            },
     ],
        "UsagePackagesList": [
             {
                "Campaign": "Automation",
                "Organizations": [
                    "CloudShare"
                ],
                "Prototypes": [
                    {
                        "Name": "automation",
                        "PrototypeId": "UGK0MB1B0VRB"
                    }
                ],
                "ResourcePackage": " Automation",
                "UsagePackageId": "RFE2RPE5J1TA"
            },

        ]
    }
}

The response will include a list of SEs available to the user, as well as a list of usage packages that can be used for invitations. The Usage Packages are a combination of campaigns, prototypes and resource packages; there can be more than one prototype associated with a usage package.

Code sample