Client API

Clients are advertisers, agencies, and brands.

Getting Started

  • Base URL: https://api.videoplaza.com/api/1.0/client
  • Requests: GET, POST, PUT, and DELETE requests are used. You pass parameters by using common REST parameters like PATH, QUERY, and MATRIX, as well as HTTP HEADERS. The body of the requests should be provided in XML format and encoded using UTF-8.
  • Responses: All responses contain an HTTP status code in the header and the body is in XML format.
  • Related user documentation: Clients

Request Body Format

To create or update a client, you need to supply a body to the request with the following format:
Note: All parameters are optional unless explicitly stated.
<clientBean>
    <comments>string</comments>
    <id>string</id>    <!-- Set only when updating a client -->
    <name>string</name>    <!-- Required -->
    <type>ADVERTISER|AGENCY|BRAND</type>    <!-- Required -->
    <email>string</email>
    <faxNumber>
        <countryCode>string</countryCode>
        <number>string</number>
    </faxNumber>              
    <phoneNumber>
        <countryCode>string</countryCode>
        <number>string</number>
    </phoneNumber>
    <postalAddress>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <country>string</country>
        <stateProvinceRegion>string</stateProvinceRegion>
        <zipCode>string</zipCode>
    </postalAddress>       
    <visitingAddress>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <country>string</country>
        <stateProvinceRegion>string</stateProvinceRegion>
        <zipCode>string</zipCode>
     </visitingAddress>
</clientBean>

Create a Client

Method POST
URL https://api.videoplaza.com/api/1.0/client
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params -
Query params -
Body Request Body Format
Success response

HTTP status: 200 OK

Header: -

Body: client ID

Example:

Request header:

POST /api/1.0/client HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <clientBean>
        <name>The BMW company</name>
        <type>BRAND</type>
        <phoneNumber>
            <countryCode>+46</countryCode>
            <number>01234567</number>
    </phoneNumber>       
    </clientBean>

Success response:

HTTP status:
  200 (OK)

Body:
84a19c28-­ba66-­411b-­a5bf-­49ecfce1e607

Delete a Client

Method DELETE
URL https://api.videoplaza.com/api/1.0/client/by_client_id
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params id: client ID
Query params -
Body -
Success response

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

DELETE /api/1.0/client/by_client_id;id=84a19c28-­ba66-­411b-­a5bf-­49ecfce1e607 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  204 (No Content)

List Clients

Method GET
URL https://api.videoplaza.com/api/1.0/client
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params -
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: list of clients

Example:

Request header:

GET /api/1.0/client HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9</id>
        <name>IKEA</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>BRAND</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean>    
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>f16dd041-a659-4f7f-bf53-b7f1fcd84bee</id>
        <name>IKEA Centres Sverige AB</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>ADVERTISER</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean> 
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>3f01fedc-06fe-442e-a185-0a8e6433cd96</id>
        <name>Bowen Media</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>AGENCY</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean>       
</collection>

List Client(s) by ID

Method GET
URL https://api.videoplaza.com/api/1.0/client/by_client_id
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params id: client ID
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: list of clients

Example:

Request header:

GET /api/1.0/client/by_client_id;id=0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9</id>
        <name>IKEA</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>BRAND</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean>
</collection>

List Clients by Campaign ID

Method GET
URL https://api.videoplaza.com/api/1.0/client/by_campaign_id
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params id: campaign ID
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: list of clients

Example:

Request header:

GET /api/1.0/client/by_campaign_id;id=93a31e4e-2158-4f03-8839-66ffe62660d1 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>f16dd041-a659-4f7f-bf53-b7f1fcd84bee</id>
        <name>IKEA Centres Sverige AB</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>ADVERTISER</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean>
    <clientBean>
        <faxNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </faxNumber>
        <id>0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9</id>
        <name>IKEA</name>
        <phoneNumber>
            <countryCode>+44</countryCode>
            <number></number>
        </phoneNumber>
        <postalAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </postalAddress>
        <type>BRAND</type>
        <visitingAddress>
            <address1></address1>
            <address2></address2>
            <city></city>
            <country>GBR</country>
            <stateProvinceRegion></stateProvinceRegion>
            <zipCode></zipCode>
        </visitingAddress>
    </clientBean>
</collection>

Update a Client

Method PUT
URL https://api.videoplaza.com/api/1.0/client/by_client_id
Header Authentication header (x-o-api-key)
Content type application/xml
Matrix params id: client ID
Query params -
Body Request Body Format
Success response

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

PUT /api/1.0/client/by_client_id;id=0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/xml
x-o-api-key="<your key>"

Request body: NA

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <clientBean>
        <comments>IKEA Sweden, furniture store.</comments>
        <id>0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9</id>
        <name>IKEA</name>
        <type>BRAND</type>
        <email/>
        <faxNumber>
            <countryCode>+46</countryCode>
            <number>87654321</number>
        </faxNumber>        
        <phoneNumber>
            <countryCode>+46</countryCode>
            <number>12345678</number>
        </phoneNumber>
        <postalAddress>
            <address1>Modulvägen 1, Kungens Kurva</address1>
            <address2/>            
            <city>Stockholm</city>
            <country>SWE</country>
            <stateProvinceRegion/>            
            <zipCode>141 75</zipCode>
        </postalAddress>
        <visitingAddress>
            <address1>Folkungavägen 50</address1>
            <address2/>             
            <city>Järfälla</city>
            <country>SWE</country>
            <stateProvinceRegion/>            
            <zipCode>177 35</zipCode>
        </visitingAddress>
    </clientBean>

Success response:

HTTP status:
  204 (No Content)

해당 내용이 도움 되었습니까?