Object Project

Methods: create | info | list | update | delete

create

Create new project

Input parameters

Required parameters:

• String email (Email of your Boomstream account)
• String title (Project title)
• String apikey (API key of your project)

Output parameters

• String ApiKey (API key of created project)
• String Title (Title of created project)
• String Code (Code of created project)

Example request:

https://boomstream.com/api/app/create?email=[EMAIL]&title=[TITLE]&apikey=[API_KEY]

Example response:

<Response>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Title>title</Title>
    <Message>Application is successfully created</Message>
    <Status>Success</Status>
</Response>

info

Information about the project

Input parameters

Required parameters:

• String apikey (API key of your project)
• String email (Email of your Boomstream account; must match the account that owns the apikey)

Output parameters

• String Title (Project title)
• String apikey (API key of your project)
• String Code (Code of your project)

Example request:

https://boomstream.com/api/app/info?apikey=[API_KEY]&email=[EMAIL]

Example response:

<Response>
    <Message>Application info</Message>
    <Title>Updated by API</Title>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

list

List of projects

Input parameters

Required parameters:

• String email (Email of your Boomstream account)
• String apikey (API key of your project)

Example request:

https://boomstream.com/api/app/list?email=[EMAIL]&apikey=[API_KEY]

Example response:

<Response>
    <Items>
        <Item>
            <ApiKey>xxx...xxx</ApiKey>
            <Title>Updated by API</Title>
            <Code>OPkmGnkl</Code>
        </Item>
        <Item>
            <ApiKey>xxx...xxx</ApiKey>
            <Title>v2</Title>
            <Code>TeRwmuvi</Code>
        </Item>
    </Items>
    <Status>Success</Status>
</Response>

update

Change project title

Input parameters

Required parameters:

• String apikey (Project API key)
• String email (Email of your Boomstream account; must match the account that owns the apikey)
• String title (Project title)

Output parameters

• String ApiKey (Project API key)
• String Title (Project title)
• String Code (Code of your project)

Example request:

https://boomstream.com/api/app/update?apikey=[API_KEY]&email=[EMAIL]&title=[TITLE]

Example response:

<Response>
    <Message>Application is successfully updated</Message>
    <Title>newTestTitle</Title>
    <ApiKey>xxx...xxx</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

delete

Delete project

Note: All information about the project will be deleted: media, folders, subscriptions, and then the project itself.

Input parameters

Required parameters:

• String apikey (User project API key)
• String apikey_delete (API key of the project to delete)
• String email (Email of your Boomstream account; must match the account that owns the apikey)

Example request:

https://boomstream.com/api/app/delete?apikey=[API_KEY]&apikey_delete=[API_KEY]&email=[EMAIL]

Example response:

<Response>
    <Message>Application is successfully deleted</Message>
    <Status>Success</Status>
</Response>