Contact API

Contacts are contact details for clients.

Getting Started

  • Base URL: https://api.videoplaza.com/api/1.0/contact
  • 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 contact, you need to supply a body to the request with the following format:
Note: All parameters are optional unless explicitly stated.
<contactBean>
    <description>string</description>
    <firstName>string</firstName>    <!-- Required -->
    <lastName>string</lastName>
    <id>string</id>    <!-- Set only when updating a contact -->
    <email>string</email>
    <faxNumber>
        <countryCode>string</countryCode>
        <number>string</number>
    </faxNumber>    
    <mobilePhoneNumber>
        <countryCode>string</countryCode>
        <number>string</number>
    </mobilePhoneNumber>
    <workPhoneNumber>
        <countryCode>string</countryCode>
        <number>string</number>
    </workPhoneNumber>
</contactBean>

Create a Contact

Method POST
URL https://api.videoplaza.com/api/1.0/contact
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: contact ID

Example:

Request header:

POST /api/1.0/contact 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"?>
<contactBean>
    <description>CEO</description>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <email>johndoe@ikea.com</email>
    <faxNumber>
        <countryCode>+46</countryCode>
        <number>87654321</number>
    </faxNumber>   
    <mobilePhoneNumber>
        <countryCode>+46</countryCode>
        <number>12345678</number>
    </mobilePhoneNumber>
    <workPhoneNumber>
        <countryCode>+46</countryCode>
        <number>11115555</number>
    </workPhoneNumber>
   </contactBean>

Success response:

HTTP status:
  200 (OK)

Body:
6d2d4fe9-c531-47ce-8581-e5bb0dfc9212

Update a Contact

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

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

PUT /api/1.0/contact/by_contact_id;id=6d2d4fe9-c531-47ce-8581-e5bb0dfc9212 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"?>
<contactBean>
    <description>CEO IKEA Sverige</description>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <id>6d2d4fe9-c531-47ce-8581-e5bb0dfc9212</id>
    <email>johndoe@ikea.com</email>
    <faxNumber>
        <countryCode>+46</countryCode>
        <number>87654321</number>
    </faxNumber>   
    <mobilePhoneNumber>
        <countryCode>+46</countryCode>
        <number>12345678</number>
    </mobilePhoneNumber>
    <workPhoneNumber>
        <countryCode>+46</countryCode>
        <number>11115555</number>
    </workPhoneNumber>
   </contactBean>

Success response:

HTTP status:
  204 (No Content)

Associate a Contact with a Client

Method PUT
URL https://api.videoplaza.com/api/1.0/contact/associate/by_contact_id
Header Authentication header (x-o-api-key)
Content type application/x-­www-­form-­urlencoded
Matrix params -
Query params -
Body
contactId=<string>;clientId=<string>
  1. contactId: ID of the contact you want to associate with a client
  2. clientId: ID of the client you want to associate with a contact
Success response

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

PUT /api/1.0/contact/associate/by_contact_id HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/x-­www-­form-­urlencoded
Content-Length: 50
x-o-api-key="<your key>"

Request body:

contactId=6d2d4fe9-c531-47ce-8581-e5bb0dfc9212;clientId=0d1d3dfb-359a-4ab9-bcf9-fb555b5accd9

Success response:

HTTP status:
  204 (No Content)

Delete a Contact

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

HTTP status: 204 No Content

Header: -

Body: -

Example:

Request header:

DELETE /api/1.0/contact/by_contact_id;id=6d2d4fe9-c531-47ce-8581-e5bb0dfc9212 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 Contact(s) by Contact ID

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

HTTP status: 200 OK

Header: -

Body: list of contacts

Example:

Request header:

GET /api/1.0/contact/by_contact_id;id=dd24b869-d7cc-449d-a350-53c1312cf904 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>
    <contactBean>
        <description>Chief Sales Officer</description>
        <email>janedoe@ikea.com</email>
        <faxNumber>
            <countryCode>+46</countryCode>
            <number>22226666</number>
        </faxNumber>
        <firstName>Jane</firstName>
        <id>dd24b869-d7cc-449d-a350-53c1312cf904</id>
        <lastName>Doe</lastName>
        <mobilePhoneNumber>
            <countryCode>+46</countryCode>
            <number>12345678</number>
        </mobilePhoneNumber>
        <workPhoneNumber>
            <countryCode>+46</countryCode>
            <number>11115555</number>
        </workPhoneNumber>
    </contactBean>
</collection>

List Contact(s) by Client ID

Method GET
URL https://api.videoplaza.com/api/1.0/contact/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 contacts

Example:

Request header:

GET /api/1.0/contact/by_client_id;id=f95936e0-­1977-­4222-­be68-­60ad90cec7d0 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"?>
<contacts>
    <contacts clientId="f95936e0-­1977-­4222-­be68-­60ad90cec7d0">
        <contactList>
            <contacts>
                <description>CEO Royco.</description>
                <email>janedoe@royco.com</email>
                <faxNumber>
                    <countryCode>+44</countryCode>
                    <number>00006666</number>
                </faxNumber>
                <firstName>Jane</firstName>
                <id>7c94d869-0871-4db0-ab53-f8f08adca782</id>
                <lastName>Doe</lastName>
                <mobilePhoneNumber>
                    <countryCode>+44</countryCode>
                    <number>44448888</number>
                </mobilePhoneNumber>
                <workPhoneNumber>
                    <countryCode>+44</countryCode>
                    <number>11112222</number>
                </workPhoneNumber>
            </contacts>
        </contactList>
    </contacts>
</contacts>

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