Adways APIs documentation

HVProjectInfo

Fields

Field	Description	Required
name	The project's name.	YES
media	The media's id ("Media" API) used by the project.	NO

GET /hv-project-info

Loads a collection of available entities. The loaded collection is paginated. An optional "search" parameter is available to filter the result on the entities' name and id (ex.: "//hv-project-info?search=SearchValue").

Request

EndPoint

https://services.adways.com/hv-project-info

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "_links": {
        "self": {
            "href": "/hv-project-info"
        },
        "first": {
            "href": "/hv-project-info?page={page}"
        },
        "prev": {
            "href": "/hv-project-info?page={page}"
        },
        "next": {
            "href": "/hv-project-info?page={page}"
        },
        "last": {
            "href": "/hv-project-info?page={page}"
        }
    },
    "_embedded": {
        "collection": [
            {
                "id": "",
                "created": "",
                "author": "",
                "updated": "",
                "updator": "",
                "level": "",
                "state": "",
                "name": "The project's name.",
                "media": "The media's id ("Media" API) used by the project.",
                "_links": {
                    "self": {
                        "href": "/hv-project-info[/:hv_project_info_id]"
                    }
                }
            }
        ]
    }
}

POST /hv-project-info

Creates an entity in HVProjectInfo. Required fields are in the API fields description above. Note that on success, the returned http status is "201, Created".

Request

EndPoint

https://services.adways.com/hv-project-info

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json
Content-Type	application/vnd.hv-project.v1+json application/json text/plain

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "name": "The project's name.",
    "media": "The media's id ("Media" API) used by the project.",
    "_links": {
        "self": {
            "href": "/hv-project-info[/:hv_project_info_id]"
        }
    }
}

GET /hv-project-info[/:hv_project_info_id]

Loads the entity with the given id.

Request

EndPoint

https://services.adways.com/hv-project-info[/:hv_project_info_id]

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "name": "The project's name.",
    "media": "The media's id ("Media" API) used by the project.",
    "_links": {
        "self": {
            "href": "/hv-project-info[/:hv_project_info_id]"
        }
    }
}

PATCH /hv-project-info[/:hv_project_info_id]

Updates a subset of the entity with the given id (only the modified fields are required).

Request

EndPoint

https://services.adways.com/hv-project-info[/:hv_project_info_id]

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json
Content-Type	application/vnd.hv-project.v1+json application/json text/plain

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "name": "The project's name.",
    "media": "The media's id ("Media" API) used by the project.",
    "_links": {
        "self": {
            "href": "/hv-project-info[/:hv_project_info_id]"
        }
    }
}

PUT /hv-project-info[/:hv_project_info_id]

Updates the entire entity with the given id (all the fields are required).

Request

EndPoint

https://services.adways.com/hv-project-info[/:hv_project_info_id]

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json
Content-Type	application/vnd.hv-project.v1+json application/json text/plain

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "name": "The project's name.",
    "media": "The media's id ("Media" API) used by the project.",
    "_links": {
        "self": {
            "href": "/hv-project-info[/:hv_project_info_id]"
        }
    }
}

DELETE /hv-project-info[/:hv_project_info_id]

Deletes the entity with the given id. Note that on success, the returned http status is "204, Entity has been deleted".

Request

EndPoint

https://services.adways.com/hv-project-info[/:hv_project_info_id]

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

HVCreateEditLink

Generates a unique and secured edition link, which will redirect the user to the Adways Studio. This method needs a valid token and token provider to launch the Adways Studio for corresponding user.

Fields

Field	Description	Required
id	The project's id to edit (a "hvProjectInfo" API entity's id).	YES
access_token	Access token used on adways studio.	NO
expires_in	Time in seconde before token expiration.	NO
refresh_token	Refresh token to use when the given access token will expires.	NO
lang		NO

POST /hv-create-edit-link

The project id is required to generate the link. Once the user is redirected to this link, given informations are set up and will be used for the user.

Request

EndPoint

https://services.adways.com/hv-create-edit-link

Headers

Header	Value
Accept	application/vnd.hv-project.v1+json application/json application/*+json
Content-Type	application/vnd.hv-project.v1+json application/json

Body

{
   "id": "HVProject id to edit with generated link."
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.hv-project.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "link": "Link to edit the project of the given HVProject id"
}

Home / Documentation

HVProject (v1)

HVProjectInfo

Fields

GET /hv-project-info

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

POST /hv-project-info

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

GET /hv-project-info[/:hv_project_info_id]

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

PATCH /hv-project-info[/:hv_project_info_id]

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

PUT /hv-project-info[/:hv_project_info_id]

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

DELETE /hv-project-info[/:hv_project_info_id]

Request

EndPoint

Headers

Response

Status Codes

Headers

HVCreateEditLink

Fields

POST /hv-create-edit-link

Request

EndPoint

Headers

Body

Response

Status Codes

Headers

Body