Kashoo API Documentation

countAppStoreBusinesses

Return the total number of businesses associated with this app store currently. An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countAppStoreUsers

Return the total number of app store users associated with this app store An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

countMatchingAppStoreBusinesses

Return a count of matching businesses which are also associated with this app store. An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
filter (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

countMatchingAppStoreUsers

Return the maximum results of the given search of users associated with the given app store. An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
filter (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

getAppStoreBusinesses

List app store businesses An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getAppStoreUsers

Get users associated with the given app store An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getLoginUrl

Get a direct login URL for the given AppStore user.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
userId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getLoginUrlUsingAppStoreId

Get a direct login URL for the given AppStore user.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
appStoreUserId (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

getMySubscriptions

When the user logs in we must check if they have pending app store businesses to add and, if so, ask them to add those businesses. To do this, the UI calls getMySubscriptions() to check for app store businesses, if there are subscriptions with business == null and the role is null, ADMIN, or CREATOR the user should be prompted to add a business. When the Add Business UI comes up, the fields may be pre-filled using the app store's provided contact information.

Input Parameters

name description
token (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)

provisionBusiness

Provision a "business" into the given app store. Whatever contact information is provided will be used to speed up the business setup process by pre-filling that information. Note that this operation is currently optional; it is only useful to provide contact/billing information about the business. Also note that you must have provisioned at least one user with a matched appStoreBusinessId. That is because the mapping between a business and appStoreBusinessId is stored in the user provisioning data currently. If the same business is provisioned twice, the existing presets/contact information will be updated with the new information provided.

Input Parameters

name description
token Authorization information; may be have just authenticationCode = AppStore's secret key and all other fields empty/null if the operation is performed by the app store itself rather than a logged in user.
appStoreId Numeric ID of the app store
appStoreBusinessId App store's internal ID for the business
businessContactInformationInfo Contact information presets for the business to speed up the business set up process

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

provisionUser

Provision a user into the given app store. Whatever contact information is provided (non-null) will be applied to the user. An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
appStoreUserId AppStore internal ID for this user (optional)
appStoreBusinessId AppStore internal ID for this business (optional)
appStoreSubscriptionId AppStore internal ID for this subscription (optional)
openID (no documentation provided)
contactInformation (no documentation provided)
accessLevel Role the user will be assigned to the associated business (optional)
testAccount (no documentation provided)

Faults

name description
AlreadyExists (no documentation provided)
NotAllowed (no documentation provided)
NotFound (no documentation provided)
ValidationFailed (no documentation provided)

removeBusiness

Remove a business which was added using provisionBusiness(). This would be called if the end-user decides to remove themselves from the system.

Input Parameters

name description
token Authorization information; may be have just authenticationCode = AppStore's secret key and all other fields empty/null if the operation is performed by the app store itself rather than a logged in user.
appStoreId Numeric ID of the app store
appStoreBusinessId App store's internal ID for the business

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

searchAppStoreBusinesses

Search for app store businesses using a lucene query string An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
filter (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

searchAppStoreUsers

Find app store users using a query string. An AppStore API client can authorize itself to this method using an auth token authenticationCode = AppStore's secret key and all other fields empty/null.

Input Parameters

name description
token (no documentation provided)
appStoreId (no documentation provided)
filter (no documentation provided)
offset (no documentation provided)
limit (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
NotAllowed (no documentation provided)
ValidationFailed (no documentation provided)

appstore-soap-1.0

Home

REST Endpoints

SOAP Services

XML Data Elements

XML Data Types