API docs by Redocly

Ayuda API (2.0.0)

Download OpenAPI specification:Download

A guide to Ayuda's new API.

Activities

Activity

This Activity endpoint saves information about a new call, email, meeting or task.

Request Body schema: application/json

Activity to be saved.

accountId
required
string

The ID of the Sales Account the Activity is associated to

accountName
string

The name of the Sales Account the Activity is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

subject
required
string

Subject

desc
string

Description

notes
string

Notes

assignedToUserId
string

The ID of the User the Activity is assigned to

assignedToUserName
string

The UserName of the User the Activity is assigned to

durationInMinutes
required
integer <int32>

Duration of the Activity in minutes

isReminderEnabled
boolean

Is Reminder Enabled?

activityStatusId
required
string

The ID of the Activity Status: Held: 98B7F0C5-DF75-47E2-B029-8725862D3BDF Not Held: D94352ED-4FA4-4399-A789-B57F381F0A12 Planned: AAE2ED28-20DD-4497-81D6-CBB35FEA6939

activityStatusName
string

The Name of the Activity Status

startDateTimeUtc
required
string <date-time>

The Start Date and Time of the Activity in UTC

createdOnUtc
string <date-time>

The date in UTC the Activity was created

createdByUserId
string

The ID of the User who created the Activity

modifiedOnUtc
string <date-time>

The date in UTC the Activity was last modified

modifiedByUserID
string

The ID of the User who last modified the Activity

activityType
required
string

The Type of the Activity: "Call", "Email", "Meeting", or "Task"

contactName
string

The Name of the Contact associated to the Activity

contactId
string

The ID of the Contact associated to the Activity

activityPurposeID
string

The ID of the activity's purpose.

customProperty1
string

A custom value.

ts
string

The timestamp of the Activity encoded in Base64

id
string

The GUID representing the Activity in the database

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "subject": "string",
  • "desc": "string",
  • "notes": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "durationInMinutes": 0,
  • "isReminderEnabled": true,
  • "activityStatusId": "string",
  • "activityStatusName": "string",
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "activityType": "string",
  • "contactName": "string",
  • "contactId": "string",
  • "activityPurposeID": "string",
  • "customProperty1": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "subject": "string",
  • "desc": "string",
  • "notes": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "durationInMinutes": 0,
  • "isReminderEnabled": true,
  • "activityStatusId": "string",
  • "activityStatusName": "string",
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "activityType": "string",
  • "contactName": "string",
  • "contactId": "string",
  • "activityPurposeID": "string",
  • "customProperty1": "string",
  • "ts": "string",
  • "id": "string"
}

Activities

This Activities endpoint returns information about calls, emails, meetings and tasks.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity

This Activities endpoint returns information about a call, email, meeting, or task.

path Parameters
id
required
string

The ID of the Activity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "subject": "string",
  • "desc": "string",
  • "notes": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "durationInMinutes": 0,
  • "isReminderEnabled": true,
  • "activityStatusId": "string",
  • "activityStatusName": "string",
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "activityType": "string",
  • "contactName": "string",
  • "contactId": "string",
  • "activityPurposeID": "string",
  • "customProperty1": "string",
  • "ts": "string",
  • "id": "string"
}

Activity

This Activity endpoint saves information about a new or updated call, email, meeting, or task.

path Parameters
id
required
string

The ID of the Activity to add or update.

Request Body schema: application/json

Activity to be saved.

accountId
required
string

The ID of the Sales Account the Activity is associated to

accountName
string

The name of the Sales Account the Activity is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

subject
required
string

Subject

desc
string

Description

notes
string

Notes

assignedToUserId
string

The ID of the User the Activity is assigned to

assignedToUserName
string

The UserName of the User the Activity is assigned to

durationInMinutes
required
integer <int32>

Duration of the Activity in minutes

isReminderEnabled
boolean

Is Reminder Enabled?

activityStatusId
required
string

The ID of the Activity Status: Held: 98B7F0C5-DF75-47E2-B029-8725862D3BDF Not Held: D94352ED-4FA4-4399-A789-B57F381F0A12 Planned: AAE2ED28-20DD-4497-81D6-CBB35FEA6939

activityStatusName
string

The Name of the Activity Status

startDateTimeUtc
required
string <date-time>

The Start Date and Time of the Activity in UTC

createdOnUtc
string <date-time>

The date in UTC the Activity was created

createdByUserId
string

The ID of the User who created the Activity

modifiedOnUtc
string <date-time>

The date in UTC the Activity was last modified

modifiedByUserID
string

The ID of the User who last modified the Activity

activityType
required
string

The Type of the Activity: "Call", "Email", "Meeting", or "Task"

contactName
string

The Name of the Contact associated to the Activity

contactId
string

The ID of the Contact associated to the Activity

activityPurposeID
string

The ID of the activity's purpose.

customProperty1
string

A custom value.

ts
string

The timestamp of the Activity encoded in Base64

id
string

The GUID representing the Activity in the database

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "subject": "string",
  • "desc": "string",
  • "notes": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "durationInMinutes": 0,
  • "isReminderEnabled": true,
  • "activityStatusId": "string",
  • "activityStatusName": "string",
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "activityType": "string",
  • "contactName": "string",
  • "contactId": "string",
  • "activityPurposeID": "string",
  • "customProperty1": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "subject": "string",
  • "desc": "string",
  • "notes": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "durationInMinutes": 0,
  • "isReminderEnabled": true,
  • "activityStatusId": "string",
  • "activityStatusName": "string",
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "activityType": "string",
  • "contactName": "string",
  • "contactId": "string",
  • "activityPurposeID": "string",
  • "customProperty1": "string",
  • "ts": "string",
  • "id": "string"
}

Activity

This Activity endpoint deletes the activity.

path Parameters
id
required
string

The ID of the Activity to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Pageable

Activities

This Activities endpoint returns information about calls, emails, meetings and tasks.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ActivityPurposes

This Activity Purpose endpoint returns information about available activity purposes.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BusinessAreas

This Business Area endpoint returns information about available business areas.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaigns

This Campaign endpoint returns information about available campaign duration.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CampaignDurationTypes

This Campaign Duration Type endpoint returns information about available campaign duration types.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Job Roles

This endpoint saves information about a new Client Job Role.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Job Titles

This endpoint saves information about a new Client Job Title.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Types

This endpoint saves information about a new Client Type.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contacts

This Contacts endpoint returns information about people, including their names, positions, and contact information.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Countries

This Country endpoint returns information about available countries.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invoice Terms

This endpoint returns information about Invoice Terms.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job Title Categories

This endpoint returns information about Job Title Categories.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job Titles

This endpoint returns information about Job Titles.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

This Language endpoint returns information about available languages.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opportunities

This Opportunities endpoint returns information about opportunities, including the dates and expected amounts.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Types

This endpoint returns all Rate Card Types. Note: By default 10 items will be retrieved, use 'take' parameter to specify number of records to return.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Accounts

This Sales Accounts endpoint returns information about Agencies and Advertisers, their Contacts, Opportunities, Calls, Meetings and Tasks.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Salutations

This Salutation endpoint returns information about available salutations.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

This endpoint returns information about Users.

  • The optional parameters may be used to filter and page through the available records.

  • Sorting: Field names must be capitalized (e.g. LastName).

Example usage with sort and filter: /Ayuda.BMS.Api/v2/users?sort=LastName&filters=[{"prop":"firstName","val":"John"},{"prop":"lastName","val":"D"}]

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity Purposes

ActivityPurposes

This Activity Purpose endpoint saves information about a new or updated activity purpose.

Request Body schema: application/json

Activity purpose to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Activity Purpose encoded in Base64

id
string

The GUID representing the Activity Purpose in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

ActivityPurposes

This Activity Purpose endpoint returns information about available activity purposes.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ActivityPurposes

This ActivityPurpose endpoint returns information about available activity purposes.

path Parameters
id
required
string

The ID of the activity purpose to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

ActivityPurposes

This Activity Purpose endpoint saves information about a new or updated activity purpose.

path Parameters
id
required
string

The ID of the activity purpose to add or update.

Request Body schema: application/json

Activity purpose to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Activity Purpose encoded in Base64

id
string

The GUID representing the Activity Purpose in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

ActivityPurpose

This ActivityPurpose endpoint deletes a activity purpose.

path Parameters
id
required
string

The ID of the activity purpose to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Reference Data

ActivityPurposes

This Activity Purpose endpoint returns information about available activity purposes.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ActivityPurposes

This ActivityPurpose endpoint returns information about available activity purposes.

path Parameters
id
required
string

The ID of the activity purpose to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Activity Statuses

This Activity Statuses endpoint returns Activity Status reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity Status

This Activity Statuses endpoint returns information about an Activity Status.

path Parameters
id
required
string

The ID of the Activity Status to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Addresses

This endpoint returns all Addresses data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser

This endpoint returns information about specific Address.

path Parameters
id
required
string

The ID of the Address to retrieve.

Responses

Response samples

Content type
application/json
{
  • "addressTypeID": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "district": "string",
  • "postalCode": "string",
  • "countryID": "string",
  • "stateID": "string",
  • "ts": "string",
  • "id": "string"
}

Advertisers

This endpoint returns all Advertisers data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser

This endpoint returns information about Advertiser with specific code.

path Parameters
code
required
string

The Code of the Advertiser to retrieve. Note: code only acceptable in query string and not route parameter.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "businessID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Advertiser

This endpoint returns information about specific Advertiser.

path Parameters
id
required
string

The ID of the Advertiser to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "businessID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

List of Advertiser addresses

This endpoint returns information about Advertiser addresses with specific advertiserID.

path Parameters
advertiserID
required
string

The ID of the Advertiser to retrieve. Note: advertiserID is only in path and not a query string.

Responses

Response samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Advertiser Categories

This endpoint returns all available Advertiser Categories data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser Category

This endpoint returns information about specific Advertiser Category.

path Parameters
id
required
string

The ID of the Advertiser Category to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "oid": "string",
  • "parentAdvertiserCategoryID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Agencies

This endpoint returns information about all available Agencies.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Agency

This Agency endpoint returns information about available Agency.

path Parameters
id
required
string

The ID of the Agency to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "businessID": "string",
  • "parentAgencyID": "string",
  • "isLive": true,
  • "clientTypeID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "oid": "string",
  • "badCreditStatus": true,
  • "ts": "string",
  • "id": "string"
}

Areas

This endpoint returns information about all available Areas.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Area

This Area endpoint returns information about available Area.

path Parameters
id
required
string

The ID of the Area to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "parentAreaId": "string",
  • "areaLevelId": "string",
  • "level": "string",
  • "isLive": true,
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Areas

This Area endpoint returns information about all Area with specified AreaGroupID.

path Parameters
areaGroupID
required
string

The ID of the associated AreaGroup.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroups

This endpoint returns information about all available AreaGroups.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroup

This AreaGroup endpoint returns information about available AreaGroup.

path Parameters
id
required
string

The ID of the AreaGroup to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

AreaGroups

This Area endpoint returns information about all Area with specified salesMarketID.

path Parameters
salesMarketID
required
string

The ID of the associated salesMarket.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivities

This endpoint returns information about all available Asset Inactivities.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivity

This endpoint returns information about available Asset Inactivity for the specified asset.

path Parameters
assetId
required
string

The ID of the Asset Inactivity to retrieve. Note: assetId is only accepted as a part of path and not in query string Ex. /ByAssetId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivity

This endpoint returns information about available Asset Inactivity.

path Parameters
id
required
string

The ID of the Asset Inactivity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "assetID": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "ts": "string",
  • "id": "string"
}

Availabilities

This endpoint returns available availabilities reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Brands

This endpoint returns information about all available Brands.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Brand

This endpoint returns information about specific Brand.

path Parameters
id
required
string

The ID of the Brand to retrieve.

Responses

Response samples

Content type
application/json
{
  • "advertiserID": "string",
  • "name": "string",
  • "advertiserCategoryID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Brands

This endpoint returns information about all available Brands assigned to specified advertiser.

path Parameters
id
required
string

The ID of the Advertiser of Brands to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BusinessAreas

This Business Area endpoint returns information about available business areas.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BusinessAreas

This Business Area endpoint returns information about available business areas.

path Parameters
id
required
string

The ID of the business area to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Business Types

This Business Types endpoint returns Business Type reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Business Type

This Business Types endpoint returns information about a Business Type.

path Parameters
id
required
string

The ID of the Business Type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Campaigns

This Campaign endpoint returns information about available campaign duration.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaigns

This Campaign endpoint returns information about available campaign.

path Parameters
id
required
string

The ID of the campaign to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "primarySalesContractAgencyID": "string",
  • "modifiedByUserID": "string",
  • "notes": "string",
  • "ts": "string",
  • "id": "string"
}

CampaignDurationTypes

This Campaign Duration Type endpoint returns information about available campaign duration types.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CampaignDurationTypes

This Campaign Duration Type endpoint returns information about available campaign duration types.

path Parameters
id
required
string

The ID of the campaign duration type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Countries

This Country endpoint returns information about available countries.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

States

This endpoint returns all states information of a specific country.

path Parameters
id
required
string

The ID of the country to retrieve states linked to it.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Countries

This Country endpoint returns information about available countries.

path Parameters
id
required
string

The ID of the country to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Design Restrictions

This endpoint returns information about Design Restrictions.

This endpoint has no optional parameters.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Properties

This endpoint returns information about all available Entity Properties. The Entity can be any of Site, Vehicle, Location, Frame, Face, BmsUser, Bundle, Business, Campaign, FacePack, PackDefinition, PackDefinitionSet, PackDefinitionSetRelease, Account, Contact and Vendor.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Properties

This endpoint returns all information about available Entity Property with the specified propertyType. The propertyType can be any of Site, Vehicle, Location, Frame, Face, BmsUser, Bundle, Business, Campaign, FacePack, PackDefinition, PackDefinitionSet, PackDefinitionSetRelease, Account, Contact and Vendor. These are only acceptable as route parameter Ex ~/ByPropertyType/Face

path Parameters
propertyType
required
string

The propertyType of the Entity Property to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Properties

This endpoint returns all information about available Entity Properties with the specified linkedToId.

path Parameters
linkedToID
required
string

The linkedToId of the Entity Properties to retrieve. Note: only as a route parameter Ex ~/ByLinkedToId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Property

This endpoint returns all information about available Entity Property.

path Parameters
id
required
string

The ID of the Entity Property to retrieve.

Responses

Response samples

Content type
application/json
{
  • "linkedToID": "string",
  • "name": "string",
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "entityPropertyType": "string",
  • "ts": "string",
  • "id": "string"
}

Face Design Restrictions

This endpoint returns information about all Face Design Restrictions.

  • The optional parameters may be used to filter and page through the available records.
query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Inactivities

This endpoint returns information about all available Face Inactivities.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Inactivity

This endpoint returns information about available Asset Inactivity for the specified asset.

path Parameters
faceId
required
string

The ID of the Face for retrieving related Face Inactivity . Note: faceId is only accepted as a part of path and not in query string Ex. /ByFaceId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Inactivity

This endpoint returns information about available Face Inactivity.

path Parameters
id
required
string

The ID of the Face Inactivity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "assetID": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "ts": "string",
  • "id": "string"
}

Languages

This Language endpoint returns information about available languages.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

This Language endpoint returns information about available languages.

path Parameters
id
required
string

The ID of the Language to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Lead Sources

This Lead Sources endpoint returns Lead Source reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lead Source

This Lead Sources endpoint returns information about a Lead Source.

path Parameters
id
required
string

The ID of the Lead Source to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Loop Templates

This endpoint returns available Loop Templates reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Loop Template

This endpoint returns information about a Loop Template.

path Parameters
id
required
string

The ID of the Loop Template to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isSpotLengthFixed": true,
  • "isLoopLengthFixed": true,
  • "fixedSpotLengthInSeconds": 0,
  • "variableSpotMinimumLengthInSeconds": 0,
  • "doesVariableSpotDefineIncrementsMultiple": true,
  • "variableSpotIncrementsInMultiplesOfInSeconds": 0,
  • "doesVariableSpotHasMaximumLength": true,
  • "variableSpotHasMaximumLengthInSeconds": 0,
  • "fixedLoopLengthInSeconds": 0,
  • "grossLoopLengthInSeconds": 0,
  • "enableAdServing": true,
  • "useProgrammaticForUnsoldTime": true,
  • "reservedProgrammaticContentDurationInSeconds": 0,
  • "notes": "string",
  • "doesFixedSpotAllowsMultiples": true,
  • "doesFixedLoopAllowsOverbooking": true,
  • "bookedContentBonusPlaysMaxRepetition": 0,
  • "bookedContentBonusPlaysMaxPercentage": 0,
  • "ts": "string",
  • "id": "string"
}

Opportunity Types

This Opportunity Types endpoint returns Opportunity Type reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opportunity Type

This Opportunity Types endpoint returns information about a Opportunity Type.

path Parameters
id
required
string

The ID of the Opportunity Type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Sales Markets

This endpoint returns Sales Market reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Market

This endpoint returns information about a Sales Market

path Parameters
id
required
string

The ID of the Sales Market to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Stages

This Sales Stages endpoint returns Sales Stage reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Stage

This Sales Stages endpoint returns information about a Sales Stage

path Parameters
id
required
string

The ID of the Sales Stage to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Salutations

This Salutation endpoint returns information about available salutations.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Salutations

This Salutation endpoint returns information about available salutations.

path Parameters
id
required
string

The ID of the Salutation to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Site Design Restrictions

This endpoint returns information about all Site Design Restrictions.

  • The optional parameters may be used to filter and page through the available records.
query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity Statuses

Activity Statuses

This Activity Statuses endpoint returns Activity Status reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activity Status

This Activity Statuses endpoint returns information about an Activity Status.

path Parameters
id
required
string

The ID of the Activity Status to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Addresses

Address

This endpoint creates a new Address.

Request Body schema: application/json

Address to be created.

NOTES:

  • addressTypeID, address1, city, postalCode, countryID fields are required.
  • countryID, addressTypeID, stateID must exist.
  • id and ts can be included as well as they can be generated by the server. (Recommended: let the server create them.)
  • Extraneous/unrecognized fields will be ignored.
addressTypeID
required
string

The GUID representing type of address in database

streetNumber
string

The Street number

address1
required
string

first address

address2
string

second address

city
required
string

city

district
string

district

postalCode
required
string

postal code

countryID
required
string

The GUID representing country in database

stateID
string

The GUID representing state in database

ts
string

The timestamp of the Address encoded in Base64

id
string

The GUID representing the Address in the database

Responses

Request samples

Content type
application/json
{
  • "addressTypeID": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "district": "string",
  • "postalCode": "string",
  • "countryID": "string",
  • "stateID": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Addresses

This endpoint returns all Addresses data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser

This endpoint returns information about specific Address.

path Parameters
id
required
string

The ID of the Address to retrieve.

Responses

Response samples

Content type
application/json
{
  • "addressTypeID": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "district": "string",
  • "postalCode": "string",
  • "countryID": "string",
  • "stateID": "string",
  • "ts": "string",
  • "id": "string"
}

Address

This endpoint updates an existing Address.

path Parameters
id
required
string

The Address's ID.

Request Body schema: application/json

Address to be updated.

NOTES:

  • ts must match the most recent timestamp of the Address being updated. It can be obtained through a GET request for this AddressID.
addressTypeID
string

The GUID representing type of address in database

streetNumber
string

The Street number

address1
string

first address

address2
string

second address

district
string

district

postalCode
string

postal code

countryID
string

The GUID representing country in database

stateID
string

The GUID representing state in database

ts
required
string

The timestamp of the Address encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "addressTypeID": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "district": "string",
  • "postalCode": "string",
  • "countryID": "string",
  • "stateID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Advertisers

Advertiser

This endpoint creates a new Advertiser.

Request Body schema: application/json

Advertiser to be created.

NOTES:

  • All request body fields are required.
  • businessID will be ignored as it will be generated by the server. It is suggested to set this to null.
  • id and ts must not be included as they will be generated by the server. Including either or both will generate a 400 - Bad Request.
  • Extraneous/unrecognized fields will be ignored.
name
required
string

Name of Advertiser

code
required
string

Code

advertiserCategoryID
required
string

The GUID representing AdvertiserCategoryID in the database

oid
required
string

The GUID representing external dependency in database

officeID
required
string

The GUID representing OfficeID of Advertiser in the database

taxIDNumber
required
string

The Tax ID number of this Advertiser in the database

clientTypeID
required
string

The GUID representing ClientTypeID of Advertiser in the database

isCreatedExternally
required
boolean

Indicates whether is created in Alto or not

badCreditStatus
required
boolean

Indicates whether Advertiser has Bad Credit or not

isLive
required
boolean

Indicates whether is still active or not

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Advertisers

This endpoint returns all Advertisers data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser

This endpoint returns information about Advertiser with specific code.

path Parameters
code
required
string

The Code of the Advertiser to retrieve. Note: code only acceptable in query string and not route parameter.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "businessID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Advertiser

This endpoint returns information about specific Advertiser.

path Parameters
id
required
string

The ID of the Advertiser to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "businessID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Advertiser

This endpoint updates an existing Advertiser.

path Parameters
id
required
string

The Advertiser's ID.

Request Body schema: application/json

Advertiser to be updated.

NOTES:

  • id is optional in the request body. If it is included in the request body it must match the id that is in the URL path.
  • ts must match the most recent timestamp of the Advertiser being updated. It can be obtained through a GET request for this AdvertiserID.
name
required
string

Name of Advertiser

code
required
string

Code

advertiserCategoryID
required
string

The GUID representing AdvertiserCategoryID in the database

oid
required
string

The GUID representing external dependency in database

officeID
required
string

The GUID representing OfficeID of Advertiser in the database

taxIDNumber
required
string

The Tax ID number of this Advertiser in the database

clientTypeID
required
string

The GUID representing ClientTypeID of Advertiser in the database

isCreatedExternally
required
boolean

Indicates whether is created in Alto or not

badCreditStatus
required
boolean

Indicates whether Advertiser has Bad Credit or not

isLive
required
boolean

Indicates whether is still active or not

ts
required
string

The timestamp of the Advertiser encoded in Base64

id
string

The ID of the Advertiser encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "advertiserCategoryID": "string",
  • "oid": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "clientTypeID": "string",
  • "isCreatedExternally": true,
  • "badCreditStatus": true,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser Address

This endpoint assign addressIDs to a specific Advertiser. NOTES: - Addreses can be created in address endpoint and not here.

Request Body schema: application/json

Advertiser address list to be assigned. NOTES:

  • primaryAddressID is required.
  • id will be the advertiserId and is required.The id in url will be ignored.
  • ts __must __ be included as we want to update the most recent advertiser.
  • Extraneous/unrecognized fields will be ignored.
primaryAddressID
string

The GUID representing primary address of specific advertiser in database

otherAddressIDs
Array of strings
ts
string

The timestamp of the Activity Status encoded in Base64

id
required
string

The GUID representing the Advertiser in the database

Responses

Request samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

List of Advertiser addresses

This endpoint returns information about Advertiser addresses with specific advertiserID.

path Parameters
advertiserID
required
string

The ID of the Advertiser to retrieve. Note: advertiserID is only in path and not a query string.

Responses

Response samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Advertiser Address

This endpoint update addressIDs of a specific Advertiser.

Request Body schema: application/json

Advertiser address list to be updated.

NOTES:

  • primaryAddressID and otherAddressIDs will be validated and replaced with entered values, If no value entered then it try to remove addresses.
  • id will be the advertiserId and is required.
  • id in the url are not used and will be ignored.
  • ts __must __ be included as we want to update the most recent advertiser.
  • Extraneous/unrecognized fields will be ignored.
primaryAddressID
string

The GUID representing primary address of specific advertiser in database

otherAddressIDs
Array of strings
ts
string

The timestamp of the Activity Status encoded in Base64

id
required
string

The GUID representing the Advertiser in the database

Responses

Request samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "primaryAddressID": "string",
  • "otherAddressIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Advertiser Categories

Advertiser Categories

This endpoint returns all available Advertiser Categories data.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Advertiser Category

This endpoint returns information about specific Advertiser Category.

path Parameters
id
required
string

The ID of the Advertiser Category to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "oid": "string",
  • "parentAdvertiserCategoryID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Agencies

Agency

This endpoint creates a new Agency.

Request Body schema: application/json

Agency to be created.

NOTE: Only name and code are required when creating a new Agency.

name
required
string

Name of Agency

code
required
string

Code

parentAgencyID
string

The GUID representing Parent of Agency in the database

isLive
boolean

Indicates whether Agency is still Live or not

clientTypeID
string

The GUID representing Client Type ID in the database

officeID
string

The GUID representing OfficeID in the database

taxIDNumber
string

The Tax Id Number related to Agency

oid
string

The GUID representing external dependency in database

badCreditStatus
boolean

Indicates whether Agency has Bad Credit or not

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "parentAgencyID": "string",
  • "isLive": true,
  • "clientTypeID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "oid": "string",
  • "badCreditStatus": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Agencies

This endpoint returns information about all available Agencies.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Agency

This Agency endpoint returns information about available Agency.

path Parameters
id
required
string

The ID of the Agency to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "businessID": "string",
  • "parentAgencyID": "string",
  • "isLive": true,
  • "clientTypeID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "oid": "string",
  • "badCreditStatus": true,
  • "ts": "string",
  • "id": "string"
}

Agency

This endpoint updates an existing Agency.

path Parameters
id
required
string

The Agency's ID.

Request Body schema: application/json

Agency to be updated.

NOTES:

  • id is optional in the request body. If it is included in the request body it must match the id that is in the URL path.
  • ts must match the most recent timestamp of the Agency being updated. It can be obtained through a GET request for this AgencyID.
name
string

Name of Agency

code
string

Code

parentAgencyID
string

The GUID representing Parent of Agency in the database

isLive
boolean

Indicates whether Agency is still Live or not

clientTypeID
string

The GUID representing Client Type ID in the database

officeID
string

The GUID representing OfficeID in the database

taxIDNumber
string

The Tax Id Number related to Agency

oid
string

The GUID representing external dependency in database

badCreditStatus
boolean

Indicates whether Agency has Bad Credit or not

ts
required
string

The timestamp of the Agency encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "parentAgencyID": "string",
  • "isLive": true,
  • "clientTypeID": "string",
  • "officeID": "string",
  • "taxIDNumber": "string",
  • "oid": "string",
  • "badCreditStatus": true,
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Areas

Area

This endpoint creates a new Area.

Request Body schema: application/json

Area to be created.

NOTE: Only name and code are required when creating a new Area.

code
required
string

Code

parentAreaId
string

The GUID representing the parent Area in the database

areaLevelId
string

The GUID representing area level in the database

level
string

Level of Area

isLive
boolean

Indicates whether Area is still Live or not

name
required
string

The Name of Area

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "parentAreaId": "string",
  • "areaLevelId": "string",
  • "level": "string",
  • "isLive": true,
  • "name": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Areas

This endpoint returns information about all available Areas.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Area

This Area endpoint returns information about available Area.

path Parameters
id
required
string

The ID of the Area to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "parentAreaId": "string",
  • "areaLevelId": "string",
  • "level": "string",
  • "isLive": true,
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Area

This endpoint updates an existing Area.

path Parameters
id
required
string

The Area's ID.

Request Body schema: application/json

Area to be updated.

NOTES:

  • id is optional in the request body. If it is included in the request body it must match the id that is in the URL path.
  • ts must match the most recent timestamp of the Area being updated. It can be obtained through a GET request for this AreaID.
code
required
string

Code

parentAreaId
string

The GUID representing the parent Area in the database

areaLevelId
string

The GUID representing area level in the database

level
string

Level of Area

isLive
boolean

Indicates whether Area is still Live or not

name
required
string

The Name of Area

ts
string

The timestamp of the Area encoded in Base64

id
string

The GUID representing the Area in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "parentAreaId": "string",
  • "areaLevelId": "string",
  • "level": "string",
  • "isLive": true,
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Area

This Area endpoint deletes an area.

path Parameters
id
required
string

The ID of the area to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Areas

This Area endpoint returns information about all Area with specified AreaGroupID.

path Parameters
areaGroupID
required
string

The ID of the associated AreaGroup.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroups

AreaGroup

This endpoint creates a new AreaGroup.

Request Body schema: application/json

AreaGroup to be created.

NOTE: Only name and code are required when creating a new AreaGroup.

code
required
string

Code

name
required
string

The Name of AreaGroup

isLive
boolean

Indicates whether AreaGroup is still Live or not

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true
}

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroups

This endpoint returns information about all available AreaGroups.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroup

This AreaGroup endpoint returns information about available AreaGroup.

path Parameters
id
required
string

The ID of the AreaGroup to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

AreaGroup

This endpoint updates an existing AreaGroup.

path Parameters
id
required
string

The AreaGroup's ID.

Request Body schema: application/json

AreaGroup to be updated.

NOTES:

  • id is optional in the request body. If it is included in the request body it must match the id that is in the URL path.
  • ts must match the most recent timestamp of the AreaGroup being updated. It can be obtained through a GET request for this AreaGroupID.
code
required
string

Code

name
required
string

The Name of AreaGroup

isLive
boolean

Indicates whether AreaGroup is still Live or not

ts
string

The timestamp of the AreaGroup encoded in Base64

id
string

The GUID representing the AreaGroup in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

AreaGroup

This AreaGroup endpoint deletes an AreaGroup.

path Parameters
id
required
string

The ID of the AreaGroup to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

AreaGroups

This Area endpoint returns information about all Area with specified salesMarketID.

path Parameters
salesMarketID
required
string

The ID of the associated salesMarket.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivities

Asset Inactivities

This endpoint returns information about all available Asset Inactivities.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivity

This endpoint returns information about available Asset Inactivity for the specified asset.

path Parameters
assetId
required
string

The ID of the Asset Inactivity to retrieve. Note: assetId is only accepted as a part of path and not in query string Ex. /ByAssetId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Asset Inactivity

This endpoint returns information about available Asset Inactivity.

path Parameters
id
required
string

The ID of the Asset Inactivity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "assetID": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "ts": "string",
  • "id": "string"
}

Asset Inactivity

This endpoint updates an existing Asset Inactivity.This endpoint call PI Api so you need to provide authentication for that Api also.

path Parameters
id
required
string

The Asset Inactivity's ID.

Request Body schema: application/json

Asset Inactivity to be updated. NOTES:

  • timestamp, id, fromDate and inactivityReason are required when updating an Asset Inactivity. All other fields are optional.
  • ts must match the most recent timestamp of the Asset Inactivity being updated. It can be obtained through a GET request for this Asset Inactivity.
fromDate
required
string <date-time>

The Start Date and Time of Asset Inactivity

toDate
string <date-time>

The Date and Time that Asset became Active agaign.

inactiveReasonID
required
string

The GUID representing the reason for Asset Inactivity in the database

estimatedEndDate
string <date-time>

The estimated Date and Time that Asset became Active agaign.

planningEndDate
string <date-time>

The planing end Date and Time of Asset Inactivity.

ts
string

The timestamp of the Asset Inactivity encoded in Base64

note
string

Note

Responses

Request samples

Content type
application/json
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "ts": "string",
  • "note": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Availabilities

Availabilities

This endpoint returns available availabilities reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Availabilities

This availabilities endpoint saves information about a list of updated availabilities.

Request Body schema: application/json

The availabilities to save.

Array
id
required
string

The GUID representing the Availability in the database

salesContractStatusTypeID
required
string

The GUID representing the Sales Contract Status Type in the database

purchaseTypeID
required
string

The GUID representing the Purchase Type in the database

faceSelectionTypeID
required
string

The GUID representing the Face Selection Type in the database

availabilityTypeID
required
string

The GUID representing the Availability Type in the database

mediaTypeGroupID
string

The GUID representing the Media Type Group in the database

isBumpableByProgrammatic
boolean

Indicates whether Availability allows to be bumped by programmatic content or not

ts
string

The timestamp of the Availability encoded in Base64

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Booking Discount Type

Booking Discount Type

This endpoint returns information about Booking Discount Types with the mentioned ids.

Request Body schema: application/json

The IDs of the Booking Discount Type to retrieve.

ids
string

An Array Of Guids

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Brands

Brands

This endpoint returns information about all available Brands.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Brand

This endpoint returns information about specific Brand.

path Parameters
id
required
string

The ID of the Brand to retrieve.

Responses

Response samples

Content type
application/json
{
  • "advertiserID": "string",
  • "name": "string",
  • "advertiserCategoryID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Brands

This endpoint returns information about all available Brands assigned to specified advertiser.

path Parameters
id
required
string

The ID of the Advertiser of Brands to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Business Areas

BusinessAreas

This Business Area endpoint saves information about a new or updated business area.

Request Body schema: application/json

Business area to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Business Area encoded in Base64

id
string

The GUID representing the Lead Source in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

BusinessAreas

This Business Area endpoint returns information about available business areas.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BusinessAreas

This Business Area endpoint returns information about available business areas.

path Parameters
id
required
string

The ID of the business area to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

BusinessAreas

This Business Area endpoint saves information about a new or updated business areas.

path Parameters
id
required
string

The ID of the business area to add or update.

Request Body schema: application/json

Business area to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Business Area encoded in Base64

id
string

The GUID representing the Lead Source in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

BusinessArea

This Business Area endpoint deletes a business area.

path Parameters
id
required
string

The ID of the business area to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Business Types

Business Types

This Business Types endpoint returns Business Type reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Business Type

This Business Types endpoint returns information about a Business Type.

path Parameters
id
required
string

The ID of the Business Type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Campaigns

Campaigns

This Campaign endpoint creates a new campaign. Note: PrimarySalesContractBmsUserID is an optional parameter.

header Parameters
sessionID
required
string

Session ID obtained from /Ayuda.BMS.API/v2/sessions/signIn

Request Body schema: application/json

Campaign to be saved.

name
required
string

Name

description
string

Description

companyID
required
string

The GUID representing company ID

advertiserID
required
string

The GUID representing advertiser ID

sendPOPDirectlyToCustomer
boolean

Indicates whether to send something to customer

publishStatusTypeID
required
string

The GUID representing publisher status ID

isPublished
boolean

Indicates whether to Publish or not

isPublishedToAlto
boolean

Indicates whether is published to Alto or not

isCreatedInAlto
boolean

Indicates whether is created in Alto or not

salesContractID
string

The GUID representing sales contract ID

salesContractNumber
required
string

The Number of sales contract

salesContractStatusTypeID
required
string

The GUID representing Sales contract status type

salesContractTypeID
required
string

The GUID representing Sales contract type

salesContractContentTypeID
required
string

The GUID representing Sales contract content type

proposalStatusTypeID
required
string

The GUID representing proposal status type

isNetAmount
boolean

Indicates whether is net amount or not

productionCostIncluded
boolean

Indicate whether production cost included or not

startDate
string <date-time>

the Start Date of Campaign

endDate
string <date-time>

The end date of campaign

signedOnDate
string <date-time>

The signed date of campaign

primarySalesContractBmsUserID
string

The GUID representing AccountExcutive of campaign in Database.

notes
string

Note about the sales contract

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "primarySalesContractAgencyID": "string",
  • "modifiedByUserID": "string",
  • "notes": "string",
  • "ts": "string",
  • "id": "string"
}

Campaigns

This Campaign endpoint returns information about available campaign duration.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaigns

This Campaign endpoint returns information about campaigns that have been modified since the supplied datetime.

path Parameters
earliestModifiedDateTime
required
string

Cutoff datetime in UTC. The method will only return campaigns modified on or after this cutoff. Example: 2018-12-31T13:30:59 Note: The time (e.g. T13:30:59) is optional. If it is included it may be necessary to format the call as: /campaigns/getCampaignsModifiedSince?earliestModifiedDateTime=2018-12-31T13:30:59

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaigns

This Campaign endpoint returns information about available campaign.

path Parameters
id
required
string

The ID of the campaign to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "primarySalesContractAgencyID": "string",
  • "modifiedByUserID": "string",
  • "notes": "string",
  • "ts": "string",
  • "id": "string"
}

Campaigns

This Campaign endpoint updates an existing campaign.

path Parameters
id
required
string

The ID of the campaign to add or update.

header Parameters
sessionID
required
string

Session ID obtained from /Ayuda.BMS.API/v2/sessions/signIn

Request Body schema: application/json

Campaign to be saved.

name
string

Name

description
string

Description

companyID
string

The GUID representing company ID

advertiserID
string

The GUID representing advertiser ID

sendPOPDirectlyToCustomer
boolean

Indicates whether to send something to customer

publishStatusTypeID
string

The GUID representing publisher status ID

isPublished
boolean

Indicates whether to Publish or not

isPublishedToAlto
boolean

Indicates whether is published to Alto or not

isCreatedInAlto
boolean

Indicates whether is created in Alto or not

salesContractID
string

The GUID representing sales contract ID

salesContractNumber
string

The Sales contract number

salesContractStatusTypeID
string

The GUID representing Sales contract status type

salesContractTypeID
string

The GUID representing Sales contract type

salesContractContentTypeID
string

The GUID representing Sales contract content type

proposalStatusTypeID
string

The GUID representing proposal status type

isNetAmount
boolean

Indicates whether is net amount or not

productionCostIncluded
boolean

Indicate whether production cost included or not

startDate
string <date-time>

the Start Date of Campaign

endDate
string <date-time>

The end date of campaign

signedOnDate
string <date-time>

The signed date of campaign

primarySalesContractBmsUserID
string

The GUID representing AccountExcutive of campaign in Database.

notes
string

Note about the sales contract

ts
string

The timestamp of the Task encoded in Base64

id
string

The GUID representing Campaign ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "notes": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "companyID": "string",
  • "advertiserID": "string",
  • "sendPOPDirectlyToCustomer": true,
  • "publishStatusTypeID": "string",
  • "isPublished": true,
  • "isPublishedToAlto": true,
  • "isCreatedInAlto": true,
  • "salesContractID": "string",
  • "salesContractNumber": "string",
  • "salesContractStatusTypeID": "string",
  • "salesContractTypeID": "string",
  • "salesContractContentTypeID": "string",
  • "proposalStatusTypeID": "string",
  • "isNetAmount": true,
  • "productionCostIncluded": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "signedOnDate": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "primarySalesContractBmsUserID": "string",
  • "primarySalesContractAgencyID": "string",
  • "modifiedByUserID": "string",
  • "notes": "string",
  • "ts": "string",
  • "id": "string"
}

Campaign Duration Types

CampaignDurationTypes

This Campaign Duration Type endpoint saves information about a new or updated campaign duration type.

Request Body schema: application/json

Campaign duration type to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Campaign Duration Type encoded in Base64

id
string

The GUID representing the Lead Source in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

CampaignDurationTypes

This Campaign Duration Type endpoint returns information about available campaign duration types.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CampaignDurationTypes

This Campaign Duration Type endpoint returns information about available campaign duration types.

path Parameters
id
required
string

The ID of the campaign duration type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

CampaignDurationTypes

This Campaign Duration Type endpoint saves information about a new or updated campaign duration types.

path Parameters
id
required
string

The ID of the campaign duration type to add or update.

Request Body schema: application/json

Campaign duration type to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Campaign Duration Type encoded in Base64

id
string

The GUID representing the Lead Source in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

CampaignDurationType

This Campaign Duration Type endpoint deletes a campaign duration type.

path Parameters
id
required
string

The ID of the campaign duration type to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Client Job Roles

Client Job Roles

This endpoint saves information about a new Client Job Role.

Request Body schema: application/json

Client Job Role to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Job Role encoded in Base64

id
string

The GUID representing the Client Job Role in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Roles

This endpoint saves information about a new Client Job Role.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Job Role

This endpoint saves information about a new Client Job Role.

path Parameters
id
required
string

The ID of the Client Job Role to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Role

This endpoint saves information about a new or updated Client Job Role.

path Parameters
id
required
string

The ID of the Job Title to add or update.

Request Body schema: application/json

Client Job Role to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Job Role encoded in Base64

id
string

The GUID representing the Client Job Role in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Role

This endpoint deletes an Client Job Role.

path Parameters
id
required
string

The ID of the Job Title to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Client Job Titles

Client Job Titles

This endpoint saves information about a new Client Job Title.

Request Body schema: application/json

Client Job Title to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Job Title encoded in Base64

id
string

The GUID representing the Client Job Title in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Titles

This endpoint saves information about a new Client Job Title.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Job Title

This endpoint saves information about a new Client Job Title.

path Parameters
id
required
string

The ID of the Client Job Title to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Title

This endpoint saves information about a new or updated Client Job Title.

path Parameters
id
required
string

The ID of the Client Job Title to add or update.

Request Body schema: application/json

Client Job Title to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Job Title encoded in Base64

id
string

The GUID representing the Client Job Title in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Job Title

This endpoint deletes an Client Job Title.

path Parameters
id
required
string

The ID of the Job Title to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Client Types

Client Types

This endpoint saves information about a new Client Type.

Request Body schema: application/json

Client Type to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Type encoded in Base64

id
string

The GUID representing the Client Type in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Types

This endpoint saves information about a new Client Type.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client Type

This endpoint saves information about a new Client Type.

path Parameters
id
required
string

The ID of the Client Type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Type

This endpoint saves information about a new or updated Client Type.

path Parameters
id
required
string

The ID of the Client Type to add or update.

Request Body schema: application/json

Client Type to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live

ts
string

The timestamp of the Client Type encoded in Base64

id
string

The GUID representing the Client Type in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Client Type

This endpoint deletes an Client Type.

path Parameters
id
required
string

The ID of the Job Title to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Contacts

Contact

This Contact endpoint saves information about a new person.

Request Body schema: application/json

Contact to be saved.

firstName
required
string

First Name

lastName
required
string

Last Name

email
string

Email Address

areaCode
string

The area code

workPhoneNumber
string

Work Phone Number

mobilePhoneNumber
string

Mobile Phone Number

contactTypeId
string

The ID of the Contact Type: Content Approval: EF9F78E6-3397-46AE-9139-5788A5505ECC Creative: 90FAC5DF-481D-4E2C-9901-7D40FBC82ECB Remit: DB3EC62E-8A2D-4877-B923-9A23C5AC3A34 Mail: DD95FE45-3D8B-4816-9AAF-9A7E34CC5081 Payment: E2DF290F-587B-48D2-87F9-A16BD45FC5D6 POP Contact: 6772BEAE-FE02-4D8F-B37C-C0F212654322 Primary: 63E037E4-03EA-43FA-B20D-D8126023D4A7

accountId
required
string

The ID of the Sales Account the Contact is associated to

accountName
string

The name of the Sales Account the Contact is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

isLive
required
boolean

Is Live

title
string

Title

role
string

The Client Job Role of the contact. While this field may contain any text, the offical list of roles can be retrieved through the ClientJobRole controller.

department
string

Department

birthDate
string <date-time>

Date of Birth

oid
string

A field not visible in the UI for storing external IDs

salutation
string

Salutation

createdOnUtc
string <date-time>

The date in UTC the Contact was created

createdByUserId
string

The ID of the User who created the Contact

modifiedOnUtc
string <date-time>

The date in UTC the Contact was last modified

modifiedByUserID
string

The ID of the User who last modified the Contact

assignedToId
string

The ID of the User the Contact is assigned to

ts
string

The timestamp of the Contact encoded in Base64

id
string

The GUID representing the Contact in the database

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "areaCode": "string",
  • "workPhoneNumber": "string",
  • "mobilePhoneNumber": "string",
  • "contactTypeId": "string",
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "isLive": true,
  • "title": "string",
  • "role": "string",
  • "department": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "oid": "string",
  • "salutation": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "assignedToId": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "areaCode": "string",
  • "workPhoneNumber": "string",
  • "mobilePhoneNumber": "string",
  • "contactTypeId": "string",
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "canAccountBeSolicited": true,
  • "isLive": true,
  • "title": "string",
  • "role": "string",
  • "department": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "oid": "string",
  • "salutation": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "assignedToId": "string",
  • "ts": "string",
  • "id": "string"
}

Contacts

This Contacts endpoint returns information about people, including their names, positions, and contact information.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contact

This Contacts endpoint returns information about a person, including their name, position, and contact information.

path Parameters
id
required
string

The ID of the Contact to retrieve.

Responses

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "areaCode": "string",
  • "workPhoneNumber": "string",
  • "mobilePhoneNumber": "string",
  • "contactTypeId": "string",
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "canAccountBeSolicited": true,
  • "isLive": true,
  • "title": "string",
  • "role": "string",
  • "department": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "oid": "string",
  • "salutation": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "assignedToId": "string",
  • "ts": "string",
  • "id": "string"
}

Contact

This Contact endpoint saves information about a new or updated person.

path Parameters
id
required
string

The ID of the Contact to add or update.

Request Body schema: application/json

Contact to be saved.

firstName
required
string

First Name

lastName
required
string

Last Name

email
string

Email Address

areaCode
string

The area code

workPhoneNumber
string

Work Phone Number

mobilePhoneNumber
string

Mobile Phone Number

contactTypeId
string

The ID of the Contact Type: Content Approval: EF9F78E6-3397-46AE-9139-5788A5505ECC Creative: 90FAC5DF-481D-4E2C-9901-7D40FBC82ECB Remit: DB3EC62E-8A2D-4877-B923-9A23C5AC3A34 Mail: DD95FE45-3D8B-4816-9AAF-9A7E34CC5081 Payment: E2DF290F-587B-48D2-87F9-A16BD45FC5D6 POP Contact: 6772BEAE-FE02-4D8F-B37C-C0F212654322 Primary: 63E037E4-03EA-43FA-B20D-D8126023D4A7

accountId
required
string

The ID of the Sales Account the Contact is associated to

accountName
string

The name of the Sales Account the Contact is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

isLive
required
boolean

Is Live

title
string

Title

role
string

The Client Job Role of the contact. While this field may contain any text, the offical list of roles can be retrieved through the ClientJobRole controller.

department
string

Department

birthDate
string <date-time>

Date of Birth

oid
string

A field not visible in the UI for storing external IDs

salutation
string

Salutation

createdOnUtc
string <date-time>

The date in UTC the Contact was created

createdByUserId
string

The ID of the User who created the Contact

modifiedOnUtc
string <date-time>

The date in UTC the Contact was last modified

modifiedByUserID
string

The ID of the User who last modified the Contact

assignedToId
string

The ID of the User the Contact is assigned to

ts
string

The timestamp of the Contact encoded in Base64

id
string

The GUID representing the Contact in the database

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "areaCode": "string",
  • "workPhoneNumber": "string",
  • "mobilePhoneNumber": "string",
  • "contactTypeId": "string",
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "isLive": true,
  • "title": "string",
  • "role": "string",
  • "department": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "oid": "string",
  • "salutation": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "assignedToId": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "areaCode": "string",
  • "workPhoneNumber": "string",
  • "mobilePhoneNumber": "string",
  • "contactTypeId": "string",
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "canAccountBeSolicited": true,
  • "isLive": true,
  • "title": "string",
  • "role": "string",
  • "department": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "oid": "string",
  • "salutation": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "assignedToId": "string",
  • "ts": "string",
  • "id": "string"
}

Contact

This Contact endpoint deletes a person's information.

path Parameters
id
required
string

The ID of the Contact to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Countries

Countries

This Country endpoint saves information about a new or updated country.

Request Body schema: application/json

Country to be saved.

name
required
string

Name

isoCode
required
string

ISO Code

isLive
required
boolean

Is Live?

ts
string

The timestamp of the Country encoded in Base64

id
string

The GUID representing the Country in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Countries

This Country endpoint returns information about available countries.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

States

This endpoint returns all states information of a specific country.

path Parameters
id
required
string

The ID of the country to retrieve states linked to it.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Countries

This Country endpoint returns information about available countries.

path Parameters
id
required
string

The ID of the country to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Countries

This Country endpoint saves information about a new or updated countries.

path Parameters
id
required
string

The ID of the country to add or update.

Request Body schema: application/json

Country to be saved.

name
required
string

Name

isoCode
required
string

ISO Code

isLive
required
boolean

Is Live?

ts
string

The timestamp of the Country encoded in Base64

id
string

The GUID representing the Country in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "isoCode": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Country

This Country endpoint deletes a country.

path Parameters
id
required
string

The ID of the country to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Design Restrictions

Design Restriction

This endpoint saves information about a new Design Restriction.

Request Body schema: application/json

Design Restriction to be saved.

name
string

The Name of Design Restriction

description
string

description of design restriction

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Design Restrictions

This endpoint returns information about Design Restrictions.

This endpoint has no optional parameters.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Design Restriction

This endpoint returns information about a Design Restriction.

path Parameters
id
required
string

The ID of the Design Restriction to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Design Restriction

This endpoint saves information about an updated Design Restriction.

path Parameters
id
required
string

The ID of the Design Restriction to update.

Request Body schema: application/json

Design Restriction to be saved.

name
string

The Name of Design Restriction

description
string

description of design restriction

isLive
boolean

Is Live?

ts
string

The timestamp of the Design Restriction line encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isLive": true,
  • "ts": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Design Restriction

This endpoint deletes a Design Restriction.

path Parameters
id
required
string

The ID of the Design Restriction to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

DigitalAvails

DigitalAvails

This endpoint searches for avails information about DigitalAvails. The optional parameters may be used to filter through the available records.

query Parameters
spotLength
required
integer <int32>

The length of the spot for which availability is tested

ids
string

The face ids for which we return the availability. Comma-separated list of UUIDs/GUIDs.

faceNumbers
string

The face numbers for which we return the availability. Comma-separated list of UUIDs/GUIDs. Must be provided if ids are not provided. Ignored if ids are provided.

startDate
string <date>

The start date of the search. If not provided, will default to today

endDate
required
string <date>

The end date of the search.

scheduleTemplateID
string

The scheduleTemplateID (id of the daypart) during which we are searching for avails. If not specified will use a full schedule.

saturation
number <float>

The saturation of the spot we would like to book (multiplies the spot length). Optional.

provideDetails
boolean

If specified and set to true, will provide details as to when each face is available or not. Optional

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DigitalAvails

This endpoint return information about available number of second in looptemplate in specified period of time.

Request Body schema: application/json

Faces and start and end date of period.

faceIds
Array of strings
startDate
string <date-time>

The start date of Avails duration.

endDate
string <date-time>

The end date of Avails duration.

Responses

Request samples

Content type
application/json
{
  • "faceIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "faceIds": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "dateTimePeriodSecondAvails": [
    ]
}

Digital Booking Lines

Digital Booking Line

This Digital Booking Line endpoint returns a Digital Booking Line associated with the supplied Digital Booking Line ID.

path Parameters
id
required
string

The ID of the Digital Booking Line to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "digitalBookingLineZoneIDs": [
    ],
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "facePackDigitalBookingLineZoneIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Digital Booking Line Zones

Digital Booking Line Zone

This Digital Booking Line Zone endpoint returns a Digital Booking Line Zone associated with the supplied Digital Booking Line Zone ID.

path Parameters
id
required
string

The ID of the Digital Booking Line Zone to retrieve.

Responses

Response samples

Content type
application/json
{
  • "digitalBookingLineID": "string",
  • "faceID": "string",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "facePackDigitalBookingLineZoneID": "string",
  • "faceRateCardAmount": "string",
  • "customRateCardAmount": "string",
  • "grossAmount": "string",
  • "discountPercentage": "string",
  • "ts": "string",
  • "id": "string"
}

DigitalPackAvails

DigitalPackAvails

This endpoint returns availability information about DigitalPackAvails

The optional parameters may be used to filter and page through the available records.

query Parameters
spotLength
required
integer <int32>

The length of the spot for which availability is tested

ids
string

The face pack ids for which we return the remaining seconds. Comma-separated list of UUIDs/GUIDs.

facePackNames
string

The face names for which we return the avaiability. Comma-separated list of UUIDs/GUIDs. Must be provided if ids is not provided. Ignored if ids are provided

startDate
string <date>

The start date of the search. If not provided, will default to today

endDate
required
string <date>

The end date of the search.

scheduleTemplateID
string

The scheduleTemplateID (id of the daypart) during which we are searching for avails. If not specified will use a full schedule.

saturation
number <float>

The saturation of the spot we would like to book (multiplies the spot length). Optional.

provideDetails
boolean

If specified and set to true, will provide details as to when each pack is available or not. Optional

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direction Facing Cultures

Direction Facing Culture

This endpoint saves information about a new Direction Facing Culture.

Request Body schema: application/json

Direction Facing Culture to be saved.

cultureName
string

The culture name (aka language) of this Direction Facing Culture

name
string

The name of this Direction Facing Culture

abbreviation
string

The description of this Direction Facing Culture

directionFacingID
string

The DirectionFacingID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "abbreviation": "string",
  • "directionFacingID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Direction Facing Culture

This endpoint returns Direction Facing Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direction Facing Culture

This endpoint returns information about Direction Facing Cultures for a specific Direction Facing

path Parameters
directionFacingId
required
string

The ID of the Direction Facing whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direction Facing Culture

This endpoint saves information about an updated Direction Facing Culture.

path Parameters
directionFacingId
required
string

The ID of the Direction Facing whose cultures are to be updated.

Request Body schema: application/json

Direction Facing Culture to be saved.

cultureName
string

The culture name (aka language) of this Direction Facing Culture

name
string

The name of this Direction Facing Culture

abbreviation
string

The description of this Direction Facing Culture

directionFacingID
string

The DirectionFacingID with which this culture is associated

ts
string

The timestamp of the Direction Facing Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "abbreviation": "string",
  • "directionFacingID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Entity Properties

Entity Properties

This endpoint returns information about all available Entity Properties. The Entity can be any of Site, Vehicle, Location, Frame, Face, BmsUser, Bundle, Business, Campaign, FacePack, PackDefinition, PackDefinitionSet, PackDefinitionSetRelease, Account, Contact and Vendor.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Entity Property

This endpoint saves information about a new entity property. The Entity can be Site or Face. Only the endDate is optional, and all others are required in the body.

Request Body schema: application/json

Entity Property to be saved.

linkedToID
required
string

The GUID representing ID of the Entity which is going to be add Property on. The Entity can be Site or Face

name
required
string

The Property Name

value
required
string

The Property Value

startDate
required
string <date-time>

The date in UTC the entity property is valid from

endDate
string <date-time>

The date in UTC the entity property is valid until

entityPropertyType
required
string
Enum: "Site" "Face"

The type of the Entity which is going to be added Property on.

Responses

Request samples

Content type
application/json
{
  • "linkedToID": "string",
  • "name": "string",
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "entityPropertyType": "Site"
}

Response samples

Content type
application/json
{
  • "linkedToID": "string",
  • "name": "string",
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "entityPropertyType": "string",
  • "ts": "string",
  • "id": "string"
}

Entity Properties

This endpoint returns all information about available Entity Property with the specified propertyType. The propertyType can be any of Site, Vehicle, Location, Frame, Face, BmsUser, Bundle, Business, Campaign, FacePack, PackDefinition, PackDefinitionSet, PackDefinitionSetRelease, Account, Contact and Vendor. These are only acceptable as route parameter Ex ~/ByPropertyType/Face

path Parameters
propertyType
required
string

The propertyType of the Entity Property to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Properties

This endpoint returns all information about available Entity Properties with the specified linkedToId.

path Parameters
linkedToID
required
string

The linkedToId of the Entity Properties to retrieve. Note: only as a route parameter Ex ~/ByLinkedToId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Property

This endpoint returns all information about available Entity Property.

path Parameters
id
required
string

The ID of the Entity Property to retrieve.

Responses

Response samples

Content type
application/json
{
  • "linkedToID": "string",
  • "name": "string",
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "entityPropertyType": "string",
  • "ts": "string",
  • "id": "string"
}

Entity Property

This endpoint saves information about an updated Entity Property.

path Parameters
id
required
string

The ID of the Entity Property to update.

Request Body schema: application/json

Entity Property to be saved.

value
required
string

Value

startDate
required
string <date-time>

The date in UTC the entity property is valid from

endDate
string <date-time>

The date in UTC the entity property is valid until

ts
string

The timestamp of the entity property encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "ts": "string"
}

Response samples

Content type
application/json
{
  • "linkedToID": "string",
  • "name": "string",
  • "value": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "entityPropertyType": "string",
  • "ts": "string",
  • "id": "string"
}

Entity Property

This endpoint deletes an Entity Property.

path Parameters
id
required
string

The ID of the Entity Property to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Entity Property

This endpoint returns information about Entity Properties with the mentioned ids.

Request Body schema: application/json

The IDs of the Entity Properties to retrieve.

ids
string

An Array Of Guids

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Face Design Restrictions

Face Design Restriction

This endpoint saves information about a new Face Design Restriction.

Request Body schema: application/json

Face Design Restriction to be saved.

faceID
required
string

The GUID representing the Face in the database

designRestrictionID
required
string

The GUID representing the Reason of restriction in the database

Responses

Request samples

Content type
application/json
{
  • "faceID": "string",
  • "designRestrictionID": "string"
}

Response samples

Content type
application/json
{
  • "faceID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Face Design Restrictions

This endpoint returns information about all Face Design Restrictions.

  • The optional parameters may be used to filter and page through the available records.
query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Design Restriction

This endpoint returns information about a Face Design Restriction.

path Parameters
id
required
string

The ID of the Face Design Restriction to retrieve.

Responses

Response samples

Content type
application/json
{
  • "faceID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Face Design Restriction

This endpoint edit information about an updated Face Design Restriction.

path Parameters
id
required
string

The ID of the Face Design Restriction to update.

Request Body schema: application/json

Face Design Restriction to be saved.

faceID
required
string

The GUID representing the Face in the database

designRestrictionID
required
string

The GUID representing the Reason of restriction in the database

ts
string

The timestamp of the FaceDesignRestriction encoded in Base64

id
string

The GUID representing the FaceDesignRestriction in the database

Responses

Request samples

Content type
application/json
{
  • "faceID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "faceID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Face Inactivities

Face Inactivities

This endpoint returns information about all available Face Inactivities.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Inactivity

This endpoint returns information about available Asset Inactivity for the specified asset.

path Parameters
faceId
required
string

The ID of the Face for retrieving related Face Inactivity . Note: faceId is only accepted as a part of path and not in query string Ex. /ByFaceId/14984e41-76ae-40f4-a93a-e55c293d7d0f

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Inactivity

This endpoint returns information about available Face Inactivity.

path Parameters
id
required
string

The ID of the Face Inactivity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "assetID": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "ts": "string",
  • "id": "string"
}

Face Inactivity

This endpoint updates an existing Face Inactivity.This endpoint call PI Api so you need to provide authentication for that Api also.

path Parameters
id
required
string

The Face Inactivity's ID.

Request Body schema: application/json

Face Inactivity to be updated. NOTES:

  • timestamp, id, fromDate and inactivityReason are required when updating a Face Inactivity. All other fields are optional.
  • ts must match the most recent timestamp of the Face Inactivity being updated. It can be obtained through a GET request for this Face Inactivity.
fromDate
required
string <date-time>

The Start Date and Time of Asset Inactivity

toDate
string <date-time>

The Date and Time that Asset became Active agaign.

inactiveReasonID
required
string

The GUID representing the reason for Asset Inactivity in the database

estimatedEndDate
string <date-time>

The estimated Date and Time that Asset became Active agaign.

planningEndDate
string <date-time>

The planing end Date and Time of Asset Inactivity.

ts
string

The timestamp of the Asset Inactivity encoded in Base64

note
string

Note

Responses

Request samples

Content type
application/json
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "inactiveReasonID": "string",
  • "estimatedEndDate": "2019-08-24T14:15:22Z",
  • "planningEndDate": "2019-08-24T14:15:22Z",
  • "ts": "string",
  • "note": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Face Packs

Face Packs

This endpoint returns all Face Packs with posted Names.

Request Body schema: application/json

Faces to be retrieved.

names
required
Array of strings

An array of Face pack name.

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Face Pack Digital Booking Line Zones

Face Pack Digital Booking Line Zone

This Face Pack Digital Booking Line Zone endpoint returns a Face Pack Digital Booking Line Zone associated with the supplied ID.

path Parameters
id
required
string

The ID of the Face Pack Digital Booking Line Zone to retrieve.

Responses

Response samples

Content type
application/json
{
  • "digitalBookingLineID": "string",
  • "facePackID": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "grossAmount": 0,
  • "digitalBookingLineZones": [
    ],
  • "ts": "string",
  • "id": "string"
}

Face Positions

Face Position

This endpoint returns all Face Positions with posted Face Ids.

Request Body schema: application/json

Faces to be retrieved.

faceIds
required
Array of strings

An array of GUID of Face Ids.

Responses

Request samples

Content type
application/json
{
  • "faceIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Face Size Cultures

Face Size Culture

This endpoint saves information about a new Face Size Culture.

Request Body schema: application/json

Face Size Culture to be saved.

cultureName
string

The culture name (aka language) of this Face Size Culture

name
string

The name of this Face Size Culture

faceSizeID
string

The FaceSizeID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "faceSizeID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Face Size Culture

This endpoint returns Face Size Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Size Culture

This endpoint returns information about Face Size Cultures for a specific Face Size

path Parameters
faceSizeId
required
string

The ID of the Face Size whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Face Size Culture

This endpoint saves information about an updated Face Size Culture.

path Parameters
faceSizeId
required
string

The ID of the Face Size whose cultures are to be updated.

Request Body schema: application/json

Face Size Culture to be saved.

cultureName
string

The culture name (aka language) of this Face Size Culture

name
string

The name of this Face Size Culture

faceSizeID
string

The FaceSizeID with which this culture is associated

ts
string

The timestamp of the Face Size Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "faceSizeID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Invoices

Invoice

The endpoint updates an existing invoice with the oid value.

path Parameters
id
required
string

The ID of the Invoice to update.

Request Body schema: application/json

Invoice oid to be saved.

oid
required
string

Oid

ts
string

The timestamp of the Invoice encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "oid": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
{
  • "oid": "string",
  • "ts": "string"
}

Invoices

This endpoint returns information about invoices, including the invoiceID and invoice Number.

The optional parameter filter may be used to filter through the available records.

Example usage with filter: /v2/invoices?filters=[{"prop":"InvoiceNumber","val":"0000025"},{"prop":"InvoiceNumber","val":"0000003"}]

query Parameters
filters
string

Array of property/value pairs, where "prop" is the field to filter, and "val" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invoice Schedule

Regenerate Invoice Schedules

This endpoint regenerates invoice schedules created by the automatic billing schedule

query Parameters
ids
required
string

The invoice schedule ids. Comma-separated list of UUIDs/GUIDs.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Invoice Terms

Invoice Term

This endpoint saves information about a new Invoice Term.

Request Body schema: application/json

Invoice Term to be saved.

name
required
string

Name

code
required
string

Code

isLive
required
boolean

Indicates if the item is available for selection

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "isLive": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "isLive": true
}

Invoice Terms

This endpoint returns information about Invoice Terms.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invoice Term

This endpoint returns information about an Invoice Term.

path Parameters
id
required
string

The ID of the Invoice Term to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "isLive": true
}

Invoice Term

This endpoint saves information about a new or updated Invoice Term.

path Parameters
id
required
string

The ID of the Invoice Term to add or update.

Request Body schema: application/json

Invoice Term to be saved.

name
required
string

Name

code
required
string

Code

isLive
required
boolean

Indicates if the item is available for selection

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "isLive": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "isLive": true
}

Invoice Term

This endpoint deletes an Invoice Term.

path Parameters
id
required
string

The ID of the Invoice Term to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Job Title Categories

Job Title Category

This endpoint saves information about a new Job Title Category.

Request Body schema: application/json

Job Title Category to be saved.

name
required
string

Name

isLive
required
boolean

Is Live?

ts
string

The timestamp of the Job Title Category encoded in Base64

id
string

The GUID representing the Job Title Category in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Job Title Categories

This endpoint returns information about Job Title Categories.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job Title Category

This endpoint returns information about a Job Title Category.

path Parameters
id
required
string

The ID of the Job Title Category to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Job Title Category

This endpoint saves information about a new or updated Job Title Category.

path Parameters
id
required
string

The ID of the Job Title Category to add or update.

Request Body schema: application/json

Job Title Category to be saved.

name
required
string

Name

isLive
required
boolean

Is Live?

ts
string

The timestamp of the Job Title Category encoded in Base64

id
string

The GUID representing the Job Title Category in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Job Title Category

This endpoint deletes an Job Title Category.

path Parameters
id
required
string

The ID of the Job Title Category to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Job Titles

Job Title

This endpoint saves information about a new Job Title.

Request Body schema: application/json

Job Title to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live?

jobTitleCategoryId
required
string

The ID of the Job Title Category

ts
string

The timestamp of the Job Title encoded in Base64

id
string

The GUID representing the Job Title in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "jobTitleCategoryId": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "jobTitleCategoryId": "string",
  • "ts": "string",
  • "id": "string"
}

Job Titles

This endpoint returns information about Job Titles.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job Title

This endpoint returns information about a Job Title.

path Parameters
id
required
string

The ID of the Job Title to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "jobTitleCategoryId": "string",
  • "ts": "string",
  • "id": "string"
}

Job Title

This endpoint saves information about a new or updated Job Title.

path Parameters
id
required
string

The ID of the Job Title to add or update.

Request Body schema: application/json

Job Title to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Is Live?

jobTitleCategoryId
required
string

The ID of the Job Title Category

ts
string

The timestamp of the Job Title encoded in Base64

id
string

The GUID representing the Job Title in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "jobTitleCategoryId": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "jobTitleCategoryId": "string",
  • "ts": "string",
  • "id": "string"
}

Job Title

This endpoint deletes an Job Title.

path Parameters
id
required
string

The ID of the Job Title to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Languages

Languages

This Language endpoint saves information about a new or updated language.

Request Body schema: application/json

Language to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Language encoded in Base64

id
string

The GUID representing the Language in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Languages

This Language endpoint returns information about available languages.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

This Language endpoint returns information about available languages.

path Parameters
id
required
string

The ID of the Language to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Languages

This Language endpoint saves information about a new or updated language.

path Parameters
id
required
string

The ID of the Language to add or update.

Request Body schema: application/json

Language to be saved.

code
required
string

Code

name
required
string

Name

desc
string

Description

abbr
string

Abbreviation

order
number <integer>

The order of appearance in the list (optional)

isLive
required
boolean

Indicates if the value is available for selection

ts
string

The timestamp of the Language encoded in Base64

id
string

The GUID representing the Language in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "desc": "string",
  • "abbr": "string",
  • "order": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Language

This Language endpoint deletes a language.

path Parameters
id
required
string

The ID of the Language to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Lead Sources

Lead Sources

This Lead Sources endpoint returns Lead Source reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lead Source

This Lead Sources endpoint returns information about a Lead Source.

path Parameters
id
required
string

The ID of the Lead Source to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Loop Templates

Loop Templates

This endpoint returns available Loop Templates reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Loop Templates

This loop templates endpoint saves information about a list of updated loop templates.

Request Body schema: application/json

The loop Templates to save.

Array
id
required
string

The GUID representing the Loop Template in the database

code
required
string

Code

name
required
string

Name

isSpotLengthFixed
required
boolean

This determines whether this spot length is fixed or not.

isLoopLengthFixed
required
boolean

This determines whether this loop length is fixed or not.

fixedSpotLengthInSeconds
number

fixed spot length in seconds. Only required if isSpotLengthFixed is true.

variableSpotMinimumLengthInSeconds
number

variable spot minimum length in seconds. Only required if isSpotLengthFixed is false.

doesVariableSpotDefineIncrementsMultiple
boolean

This determines whether Variable Spot Define Increments Multiple or not. Only required if isSpotLengthFixed is false.

variableSpotIncrementsInMultiplesOfInSeconds
number

variable Spot Increments In Multiples Of In Seconds. Only required if doesVariableSpotDefineIncrementsMultiple is true and isSpotLengthFixed is false.

doesVariableSpotHasMaximumLength
boolean

This determines whether Variable Spot Has Maximum Length or not. Only required if isSpotLengthFixed is false.

variableSpotHasMaximumLengthInSeconds
number

variable Spot Maximum Length In Seconds. Only required if doesVariableSpotHasMaximumLength is true and isSpotLengthFixed is false.

fixedLoopLengthInSeconds
number

fixed loop length in seconds. Only required if isLoopLengthFixed is true.

grossLoopLengthInSeconds
number

gross loop length in seconds.

enableAdServing
required
boolean

This determines whether Advertiser Serving enabled or not.

useProgrammaticForUnsoldTime
boolean

This determines whether use Programmatic For Unsold Time or not. Only required if enableAdServing is true.

reservedProgrammaticContentDurationInSeconds
number

reserved Programmatic Content Duration in seconds. Only required if enableAdServing is true.

ts
required
string

The timestamp of the Loop Template encoded in Base64

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Loop Template

This endpoint returns information about a Loop Template.

path Parameters
id
required
string

The ID of the Loop Template to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isSpotLengthFixed": true,
  • "isLoopLengthFixed": true,
  • "fixedSpotLengthInSeconds": 0,
  • "variableSpotMinimumLengthInSeconds": 0,
  • "doesVariableSpotDefineIncrementsMultiple": true,
  • "variableSpotIncrementsInMultiplesOfInSeconds": 0,
  • "doesVariableSpotHasMaximumLength": true,
  • "variableSpotHasMaximumLengthInSeconds": 0,
  • "fixedLoopLengthInSeconds": 0,
  • "grossLoopLengthInSeconds": 0,
  • "enableAdServing": true,
  • "useProgrammaticForUnsoldTime": true,
  • "reservedProgrammaticContentDurationInSeconds": 0,
  • "notes": "string",
  • "doesFixedSpotAllowsMultiples": true,
  • "doesFixedLoopAllowsOverbooking": true,
  • "bookedContentBonusPlaysMaxRepetition": 0,
  • "bookedContentBonusPlaysMaxPercentage": 0,
  • "ts": "string",
  • "id": "string"
}

Loop Template

This endpoint returns information about Loop Templates with the mentioned ids.

Request Body schema: application/json

The IDs of the Loop Template to retrieve.

ids
string

An Array Of Guids

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Cultures

Media Type Culture

This endpoint saves information about a new Media Type Culture.

Request Body schema: application/json

Media Type Culture to be saved.

cultureName
string

The culture name (aka language) of this Media Type Culture

name
string

The name of this Media Type Culture

description
string

The description of this Media Type Culture

mediaTypeID
string

The MediaTypeID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "description": "string",
  • "mediaTypeID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Culture

This endpoint returns Media Type Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Culture

This endpoint returns information about Media Type Cultures for a specific Media Type

path Parameters
mediaTypeId
required
string

The ID of the Media Type whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Culture

This endpoint saves information about an updated Media Type Culture.

path Parameters
mediaTypeId
required
string

The ID of the Media Type whose cultures are to be updated.

Request Body schema: application/json

Media Type Culture to be saved.

cultureName
string

The culture name (aka language) of this Media Type Culture

name
string

The name of this Media Type Culture

description
string

The description of this Media Type Culture

mediaTypeID
string

The MediaTypeID with which this culture is associated

ts
string

The timestamp of the Media Type Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "description": "string",
  • "mediaTypeID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Group Cultures

Media Type Group Culture

This endpoint saves information about a new Media Type Group Culture.

Request Body schema: application/json

Media Type Group Culture to be saved.

cultureName
string

The culture name (aka language) of this Media Type Group Culture

name
string

The name of this Media Type Group Culture

description
string

The description of this Media Type Group Culture

mediaTypeGroupID
string

The MediaTypeGroupID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "description": "string",
  • "mediaTypeGroupID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Group Culture

This endpoint returns Media Type Group Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Group Culture

This endpoint returns information about Media Type Group Cultures for a specific Media Type Group

path Parameters
mediaTypeGroupId
required
string

The ID of the Media Type Group whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Media Type Group Culture

This endpoint saves information about an updated Media Type Group Culture.

path Parameters
mediaTypeGroupId
required
string

The ID of the Media Type Group whose cultures are to be updated.

Request Body schema: application/json

Media Type Group Culture to be saved.

cultureName
string

The culture name (aka language) of this Media Type Group Culture

name
string

The name of this Media Type Group Culture

description
string

The description of this Media Type Group Culture

mediaTypeGroupID
string

The MediaTypeGroupID with which this culture is associated

ts
string

The timestamp of the Media Type Group Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "description": "string",
  • "mediaTypeGroupID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Opportunities

Opportunity

This Opportunity endpoint saves information about a new opportunity.

Request Body schema: application/json

Opportunity to be saved.

accountId
required
string

The ID of the Sales Account the Opportunity is associated to

accountName
string

The name of the Sales Account the Opportunity is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

code
required
string

Code

name
required
string

Name

opportunityTypeId
required
string

The ID of the Opportunity Type: New Business: 73929DDD-2492-4DE0-913A-A5A184FA45EA Existing Business: 66D28F30-B3AA-40A1-8B99-E1AD1FB992F3

opportunityTypeName
string

The Name of the Opportunity Type

description
string

Description

amount
required
number <double>

Expected Amount

bestCaseAmount
number <double>

Best Case Amount

worstCaseAmount
number <double>

Worst Case Amount

probabilityOfClosing
integer <int32>

Probability of Closing in percent

nextStep
string

Next step to take

expectedCloseDate
required
string <date-time>

Expected Close Date

expectedCampaignStartDate
string <date-time>

Expected Campaign Start Date

expectedCampaignDurationTypeId
string

The ID of the Expected Campaign Duration Type. The list of possible vales can be queried through the CampaignDurationTypes endpoint.

expectedCampaignDurationTypeName
string

The Name of the Expected Campaign Duration Type

Array of objects (OpportunityBusinessArea)
leadSourceId
string

The ID of the Lead Source: Direct Mail: D4F16A5B-2919-4616-BBC7-2C2BBF1252A2 Public Relations: E8D0B494-87BB-4023-9531-6DE0E1B47DEC Website: 2B86F581-3271-4538-89DD-84BD8A5CCCBC Trade Show: 3544AB9F-6983-4FBD-B221-99C5872F7769 Partner: EFEEACDA-7ED1-4BE8-ABC0-AF361F518F77 Email: CC82D946-D8EC-445D-8A09-B21D516FCAC9 Word of Mouth: D5EEAD3B-292E-4431-BAC4-C736B24687A2 Other: 3EB79921-4B81-4DFC-B406-C893DF13F360 Existing Customer: 582274DA-83A0-4F8A-90EB-CDA678AB0F3C Conference: 70B2B996-6AE5-4BEC-94FB-D5CDA2462085 Cold Call: 07784117-345A-4B10-A30D-D710E9F495B3 Self Generated: 00BBEE55-DE01-4644-BC36-FAD9080654F9

salesStageId
required
string

The ID of the Sales Stage: Proposal/Price Quote: C62FC096-D702-4062-A2D9-0690E8CAC660 Review: DF59529F-7005-4AD1-A815-120BD5E49B98 Negotiation: DA21521B-07D2-46D8-9EA8-2A2A42A79EE7 Closed Lost: 1BE3F713-2022-45DD-8DED-B7BB2B67CBA9 Prospecting: 7499FB3A-C540-400E-BA47-C7CAD5E6EA0A Closed Won: C0F97893-101A-4283-BA46-CA8E1852BDFD

salesStageName
string

The Name of the Sales Stage

assignedToUserId
string

The ID of the User the Opportunity is assigned to

assignedToUserName
string

The UserName of the User the Opportunity is assigned to

expiresOnUtc
string <date-time>

The date in UTC on which the opportunity expires

closedOnUtc
string <date-time>

The date in UTC on which the opportunity was closed

createdOnUtc
string <date-time>

The date in UTC the Opportunity was created

createdByUserId
string

The ID of the User who created the Opportunity

modifiedOnUtc
string <date-time>

The date in UTC the Opportunity was last modified

modifiedByUserID
string

The ID of the User who last modified the Opportunity

ts
string

The timestamp of the Opportunity encoded in Base64

id
string

The GUID representing the Opportunity in the database

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "code": "string",
  • "name": "string",
  • "opportunityTypeId": "string",
  • "opportunityTypeName": "string",
  • "description": "string",
  • "amount": 0,
  • "bestCaseAmount": 0,
  • "worstCaseAmount": 0,
  • "probabilityOfClosing": 0,
  • "nextStep": "string",
  • "expectedCloseDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignStartDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignDurationTypeId": "string",
  • "expectedCampaignDurationTypeName": "string",
  • "opportunityBusinessAreas": [
    ],
  • "leadSourceId": "string",
  • "salesStageId": "string",
  • "salesStageName": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "closedOnUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "code": "string",
  • "name": "string",
  • "opportunityTypeId": "string",
  • "opportunityTypeName": "string",
  • "description": "string",
  • "amount": 0,
  • "bestCaseAmount": 0,
  • "worstCaseAmount": 0,
  • "probabilityOfClosing": 0,
  • "nextStep": "string",
  • "expectedCloseDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignStartDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignDurationTypeId": "string",
  • "expectedCampaignDurationTypeName": "string",
  • "opportunityBusinessAreas": [
    ],
  • "leadSourceId": "string",
  • "salesStageId": "string",
  • "salesStageName": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "closedOnUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "ts": "string",
  • "id": "string"
}

Opportunities

This Opportunities endpoint returns information about opportunities, including the dates and expected amounts.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opportunity

This Opportunities endpoint returns information about an opportunity, including its dates and expected amounts.

path Parameters
id
required
string

The ID of the Opportunity to retrieve.

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "code": "string",
  • "name": "string",
  • "opportunityTypeId": "string",
  • "opportunityTypeName": "string",
  • "description": "string",
  • "amount": 0,
  • "bestCaseAmount": 0,
  • "worstCaseAmount": 0,
  • "probabilityOfClosing": 0,
  • "nextStep": "string",
  • "expectedCloseDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignStartDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignDurationTypeId": "string",
  • "expectedCampaignDurationTypeName": "string",
  • "opportunityBusinessAreas": [
    ],
  • "leadSourceId": "string",
  • "salesStageId": "string",
  • "salesStageName": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "closedOnUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "ts": "string",
  • "id": "string"
}

Opportunity

This Opportunity endpoint saves information about a new or updated opportunity.

path Parameters
id
required
string

The ID of the Opportunity to add or update.

Request Body schema: application/json

Opportunity to be saved.

accountId
required
string

The ID of the Sales Account the Opportunity is associated to

accountName
string

The name of the Sales Account the Opportunity is associated to

accountAdditionalName
string

The additional name of the Sales Account the Activity is associated to

code
required
string

Code

name
required
string

Name

opportunityTypeId
required
string

The ID of the Opportunity Type: New Business: 73929DDD-2492-4DE0-913A-A5A184FA45EA Existing Business: 66D28F30-B3AA-40A1-8B99-E1AD1FB992F3

opportunityTypeName
string

The Name of the Opportunity Type

description
string

Description

amount
required
number <double>

Expected Amount

bestCaseAmount
number <double>

Best Case Amount

worstCaseAmount
number <double>

Worst Case Amount

probabilityOfClosing
integer <int32>

Probability of Closing in percent

nextStep
string

Next step to take

expectedCloseDate
required
string <date-time>

Expected Close Date

expectedCampaignStartDate
string <date-time>

Expected Campaign Start Date

expectedCampaignDurationTypeId
string

The ID of the Expected Campaign Duration Type. The list of possible vales can be queried through the CampaignDurationTypes endpoint.

expectedCampaignDurationTypeName
string

The Name of the Expected Campaign Duration Type

Array of objects (OpportunityBusinessArea)
leadSourceId
string

The ID of the Lead Source: Direct Mail: D4F16A5B-2919-4616-BBC7-2C2BBF1252A2 Public Relations: E8D0B494-87BB-4023-9531-6DE0E1B47DEC Website: 2B86F581-3271-4538-89DD-84BD8A5CCCBC Trade Show: 3544AB9F-6983-4FBD-B221-99C5872F7769 Partner: EFEEACDA-7ED1-4BE8-ABC0-AF361F518F77 Email: CC82D946-D8EC-445D-8A09-B21D516FCAC9 Word of Mouth: D5EEAD3B-292E-4431-BAC4-C736B24687A2 Other: 3EB79921-4B81-4DFC-B406-C893DF13F360 Existing Customer: 582274DA-83A0-4F8A-90EB-CDA678AB0F3C Conference: 70B2B996-6AE5-4BEC-94FB-D5CDA2462085 Cold Call: 07784117-345A-4B10-A30D-D710E9F495B3 Self Generated: 00BBEE55-DE01-4644-BC36-FAD9080654F9

salesStageId
required
string

The ID of the Sales Stage: Proposal/Price Quote: C62FC096-D702-4062-A2D9-0690E8CAC660 Review: DF59529F-7005-4AD1-A815-120BD5E49B98 Negotiation: DA21521B-07D2-46D8-9EA8-2A2A42A79EE7 Closed Lost: 1BE3F713-2022-45DD-8DED-B7BB2B67CBA9 Prospecting: 7499FB3A-C540-400E-BA47-C7CAD5E6EA0A Closed Won: C0F97893-101A-4283-BA46-CA8E1852BDFD

salesStageName
string

The Name of the Sales Stage

assignedToUserId
string

The ID of the User the Opportunity is assigned to

assignedToUserName
string

The UserName of the User the Opportunity is assigned to

expiresOnUtc
string <date-time>

The date in UTC on which the opportunity expires

closedOnUtc
string <date-time>

The date in UTC on which the opportunity was closed

createdOnUtc
string <date-time>

The date in UTC the Opportunity was created

createdByUserId
string

The ID of the User who created the Opportunity

modifiedOnUtc
string <date-time>

The date in UTC the Opportunity was last modified

modifiedByUserID
string

The ID of the User who last modified the Opportunity

ts
string

The timestamp of the Opportunity encoded in Base64

id
string

The GUID representing the Opportunity in the database

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "code": "string",
  • "name": "string",
  • "opportunityTypeId": "string",
  • "opportunityTypeName": "string",
  • "description": "string",
  • "amount": 0,
  • "bestCaseAmount": 0,
  • "worstCaseAmount": 0,
  • "probabilityOfClosing": 0,
  • "nextStep": "string",
  • "expectedCloseDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignStartDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignDurationTypeId": "string",
  • "expectedCampaignDurationTypeName": "string",
  • "opportunityBusinessAreas": [
    ],
  • "leadSourceId": "string",
  • "salesStageId": "string",
  • "salesStageName": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "closedOnUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string",
  • "accountAdditionalName": "string",
  • "code": "string",
  • "name": "string",
  • "opportunityTypeId": "string",
  • "opportunityTypeName": "string",
  • "description": "string",
  • "amount": 0,
  • "bestCaseAmount": 0,
  • "worstCaseAmount": 0,
  • "probabilityOfClosing": 0,
  • "nextStep": "string",
  • "expectedCloseDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignStartDate": "2019-08-24T14:15:22Z",
  • "expectedCampaignDurationTypeId": "string",
  • "expectedCampaignDurationTypeName": "string",
  • "opportunityBusinessAreas": [
    ],
  • "leadSourceId": "string",
  • "salesStageId": "string",
  • "salesStageName": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "expiresOnUtc": "2019-08-24T14:15:22Z",
  • "closedOnUtc": "2019-08-24T14:15:22Z",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "ts": "string",
  • "id": "string"
}

Opportunity

This Opportunity endpoint deletes the opportunity.

path Parameters
id
required
string

The ID of the Opportunity to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Opportunity Types

Opportunity Types

This Opportunity Types endpoint returns Opportunity Type reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opportunity Type

This Opportunity Types endpoint returns information about a Opportunity Type.

path Parameters
id
required
string

The ID of the Opportunity Type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Purchase Type Cultures

Purchase Type Culture

This endpoint saves information about a new Purchase Type Culture.

Request Body schema: application/json

Purchase Type Culture to be saved.

cultureName
string

The culture name (aka language) of this Purchase Type Culture

name
string

The name of this Purchase Type Culture

purchaseTypeID
string

The PurchaseTypeID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "purchaseTypeID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Purchase Type Culture

This endpoint returns Purchase Type Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purchase Type Culture

This endpoint returns information about Purchase Type Cultures for a specific Purchase Type

path Parameters
purchaseTypeId
required
string

The ID of the Purchase Type whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purchase Type Culture

This endpoint saves information about an updated Purchase Type Culture.

path Parameters
purchaseTypeId
required
string

The ID of the Purchase Type whose cultures are to be updated.

Request Body schema: application/json

Purchase Type Culture to be saved.

cultureName
string

The culture name (aka language) of this Purchase Type Culture

name
string

The name of this Purchase Type Culture

purchaseTypeID
string

The PurchaseTypeID with which this culture is associated

ts
string

The timestamp of the Purchase Type Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "purchaseTypeID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Types

Rate Card Type

This endpoint saves information about a new Rate Card Type.

Request Body schema: application/json

Rate Card Type to be saved.

code
required
string

Name of rateCardType Note:In API alert message it is appeared as Name not Code (due to keeping harmoony with UI).

name
required
string

Description of rateCardType Note:In API alert message it is appeared as Description not Name (due to keeping harmoony with UI).

pricingMethodID
string

The GUID representing the pricingMethod in the database.

rateCardValueTypeID
string

The GUID representing the Rate Card Value Type in the database.

isAdditionalRevenue
boolean

This determines whether is additional revenue or not.

salesContractOtherCostTypeID
string

The GUID representing the Additional Revenue Type in the database.

isLive
boolean

This determines whether is active or not.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "pricingMethodID": "string",
  • "rateCardValueTypeID": "string",
  • "isAdditionalRevenue": true,
  • "salesContractOtherCostTypeID": "string",
  • "isLive": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Types

This endpoint returns all Rate Card Types. Note: By default 10 items will be retrieved, use 'take' parameter to specify number of records to return.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Types

This endpoint return all Rate Card Types with posted IDs.

Request Body schema: application/json

Rate Card Types to be retrieved.

ids
required
string

A comma seperated GUID of Rate Type Card Ids.

Responses

Request samples

Content type
application/json
{
  • "ids": "35622359-912e-41dc-877d-6996c70b5c9a,b034d04a-b4ed-406c-8d89-3ddc41bfdfd1"
}

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Types

This endpoint returns information about Rate Card Type with a specific id

path Parameters
id
required
string

The ID of the Rate Card Type to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "pricingMethodID": "string",
  • "rateCardValueTypeID": "string",
  • "isAdditionalRevenue": true,
  • "salesContractOtherCostTypeID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Rate Card Type

This endpoint saves information about an updated Rate Card Type.

path Parameters
id
required
string

The ID of the Rate Card Type to be updated.

Request Body schema: application/json

Rate Card Type to be updated.

code
required
string

Name of rateCardType Note:In API alert message it is appeared as Name not Code (due to keeping harmoony with UI).

name
required
string

Description of rateCardType Note:In API alert message it is appeared as Description not Name (due to keeping harmoony with UI).

pricingMethodID
string

The GUID representing the pricingMethod in the database

rateCardValueTypeID
string

The GUID representing the Rate Card Value Type in the database.

isAdditionalRevenue
boolean

This determines whether is additional revenue or not.

salesContractOtherCostTypeID
string

The GUID representing the Additional Revenue Type in the database.

isLive
boolean

This determines whether is active or not.

ts
string

The timestamp of the Rate Card Type encoded in Base64

id
string

The GUID representing the Rate Card Type in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "pricingMethodID": "string",
  • "rateCardValueTypeID": "string",
  • "isAdditionalRevenue": true,
  • "salesContractOtherCostTypeID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "pricingMethodID": "string",
  • "rateCardValueTypeID": "string",
  • "isAdditionalRevenue": true,
  • "salesContractOtherCostTypeID": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Rate Card Type

This endpoint deletes a Rate Card Type.

path Parameters
id
required
string

The ID of the Rate Card Type to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Rate Card Value

This endpoint saves information about a new Rate Card Value related to specific rateCardTypeId. Note: rateCardTypeID will be selected from path. If provided in body, it will be ignored.

path Parameters
rateCardTypeId
required
string

ID of Rate Card Type that Rate Card Value belongs to.

Request Body schema: application/json

Rate Card Value to be saved.

rateCardDurationTypeID
string <uuid>

The GUID representing a Rate Card Duration Type.

fromDate
required
string <date-time>

The start date of value.

toDate
string <date-time>

The expire date of value.

amount
number <double>

The amount of Rate Card Value.

salesContractItemTypeID
string

The GUID representing the sales Contract Item Type in the database

limitedDurationStartDate
string <date-time>

The start date of limited duration.

limitedDurationEndDate
string <date-time>

The expire date of limited duration.

isPerSecondRate
boolean

This determines whether is per second rate or not.

isLimitedDuration
boolean

This determines whether is limited durattion or not.

description
string

Description.

Responses

Request samples

Content type
application/json
{
  • "rateCardDurationTypeID": "96d3f762-ae5f-43cc-b4d9-db98b98a22f1",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "salesContractItemTypeID": "string",
  • "limitedDurationStartDate": "2019-08-24T14:15:22Z",
  • "limitedDurationEndDate": "2019-08-24T14:15:22Z",
  • "isPerSecondRate": true,
  • "isLimitedDuration": true,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "rateCardDurationTypeID": "96d3f762-ae5f-43cc-b4d9-db98b98a22f1",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "salesContractItemTypeID": "string",
  • "limitedDurationStartDate": "2019-08-24T14:15:22Z",
  • "limitedDurationEndDate": "2019-08-24T14:15:22Z",
  • "isPerSecondRate": true,
  • "isLimitedDuration": true,
  • "description": "string",
  • "ts": "string",
  • "id": "string"
}

Rate Card Values

This endpoint returns information about all Rate Card values belong to Rate Card Type with specified rateCardTypeId.

path Parameters
rateCardTypeId
required
string

The ID of the Rate Card Type whose Rate Card Values to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Type Linked Faces

This endpoint links faces to specific rateCardTypeId.

path Parameters
id
required
string

ID of Rate Card Type that want to link faces.

Request Body schema: application/json

IDs of Faces that want to link.

Array
string

The GUID representing Face in database.

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "faceIDs": [
    ]
}

Rate Card Type UnLinked Faces

This endpoint unlinks faces from specific rateCardTypeId.

path Parameters
id
required
string

ID of Rate Card Type that want to unlink faces.

Request Body schema: application/json

IDs of Faces that want to unlink.

Array
string

The GUID representing Face in database.

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "faceIDs": [
    ]
}

Rate Card Type Linked Faces

This endpoint returns information about all Linked Faces belong to Rate Card Type with specified rateCardTypeId.

path Parameters
rateCardTypeId
required
string

The ID of the Rate Card Type whose Linked Faces to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Type Linked FacePacks

This endpoint links facePacks to specific rateCardTypeId.

path Parameters
id
required
string

ID of Rate Card Type that want to link facePacks.

Request Body schema: application/json

IDs of FacePacks that want to link.

Array
string

The GUID representing FacePack in database.

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "facePackIDs": [
    ]
}

Rate Card Type UnLinked FacePacks

This endpoint unlinks facePacks from specific rateCardTypeId.

path Parameters
id
required
string

ID of Rate Card Type that want to unlink facePacks.

Request Body schema: application/json

IDs of FacePacks that want to unlink.

Array
string

The GUID representing FacePack in database.

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "facePackIDs": [
    ]
}

Rate Card Type Linked FacePacks

This endpoint returns information about all Linked FacePacks belong to Rate Card Type with specified rateCardTypeId.

path Parameters
rateCardTypeId
required
string

The ID of the Rate Card Type whose Linked FacePacks to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rate Card Values

Rate Card Value

This endpoint saves information about an updated Rate Card Value. Note: rateCardTypeID will be selected from path. If provided in body, it will be ignored.

path Parameters
rateCardValueID
required
string

The ID of the Rate Card Value to be updated.

Request Body schema: application/json

Rate Card Value to be updated.

rateCardDurationTypeID
string <uuid>

The GUID representing a Rate Card Duration Type.

fromDate
required
string <date-time>

The start date of value.

toDate
string <date-time>

The expire date of value.

amount
number <double>

The amount of Rate Card Value.

salesContractItemTypeID
string

The GUID representing the sales Contract Item Type in the database

limitedDurationStartDate
string <date-time>

The start date of limited duration.

limitedDurationEndDate
string <date-time>

The expire date of limited duration.

isPerSecondRate
boolean

This determines whether is per second rate or not.

isLimitedDuration
boolean

This determines whether is limited durattion or not.

description
string

Description.

ts
string

The timestamp of the Rate Card Value encoded in Base64

id
required
string

The GUID representing the Rate Card Value in the database

Responses

Request samples

Content type
application/json
{
  • "rateCardDurationTypeID": "96d3f762-ae5f-43cc-b4d9-db98b98a22f1",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "salesContractItemTypeID": "string",
  • "limitedDurationStartDate": "2019-08-24T14:15:22Z",
  • "limitedDurationEndDate": "2019-08-24T14:15:22Z",
  • "isPerSecondRate": true,
  • "isLimitedDuration": true,
  • "description": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "rateCardTypeID": "string",
  • "rateCardDurationTypeID": "96d3f762-ae5f-43cc-b4d9-db98b98a22f1",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "salesContractItemTypeID": "string",
  • "limitedDurationStartDate": "2019-08-24T14:15:22Z",
  • "limitedDurationEndDate": "2019-08-24T14:15:22Z",
  • "isPerSecondRate": true,
  • "isLimitedDuration": true,
  • "description": "string",
  • "ts": "string",
  • "id": "string"
}

Rate Card Value

This endpoint deletes a Rate Card Value.

path Parameters
rateCardValueID
required
string

The ID of the Rate Card Value to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Sales Accounts

Sales Account

This Sales Account endpoint saves information about a new Agency or Advertiser.

Request Body schema: application/json

Sales Account to be saved.

name
required
string

Name

additionalName
string

Additional Name

additionalName2
string

Additional Name 2

additionalName3
string

Additional Name 3

code
required
string

Code

businessTypeId
required
string

The ID of the Business Type: Agency: 00CB21B1-BC45-480A-9B87-140282242D6E Advertiser: AD263CA3-FC26-4AC3-B7FE-73FAE652BA8E

businessTypeName
string

Business Type Name

oid
string

A field not visible in the UI for storing external IDs

streetNumber
string

Street Number

address1
string

Address Line 1

address2
string

Address Line 2

city
string

City

postalCode
string

Postal/ZIP Code

countryId
string

An ID representing the Country in the database

stateId
string

An ID representing the State in the database

areaCode
string

The phone number's area code

phoneNumber
string

Phone Number

languageId
string

An ID representing the Language

languageName
string

Language

emailAddress
string

Email Address

clientTypeID
string

The ID of the account client type

assignedToUserId
string

The ID of the User the Sales Account is assigned to

assignedToUserName
string

The UserName of the User the Sales Account is assigned to

isLocked
boolean

Is Locked

canBeSolicited
boolean
Default: true

Indicates if the account can be solicited.

lat
number <double>

Latitude

lng
number <double>

Longitude

customProperty1
string

A custom value.

automaticallyApproveUploadedDesigns
boolean

Indicates that the designs for this sales account are automatically approved on upload

badCreditStatus
boolean

Indicates that the sales account has bad credit status and shouldn't be able to order

invoiceTermID
string

An ID representing the invoice term in the database

debtorCode
string

Debtor code that can be used to identify this sales account in financial backoffice

Array of objects (EntityProperty)

Contains finance related attributes. Available attribute names: 'VAT Obligation', 'VAT ID Number'

lastVisitedOnUtc
string <date-time>

The date in UTC the Business was last visited

lastVisitedByUserId
string

The ID of the User who last visited the Business

createdOnUtc
string <date-time>

The date in UTC the Sales Account was created

createdByUserId
string

The ID of the User who created the Sales Account

modifiedOnUtc
string <date-time>

The date in UTC the Sales Account was last modified

modifiedByUserID
string

The ID of the User who last modified the Sales Account

Array of objects (Contact)
Array of objects (Opportunity)
Array of objects (Activity)
Array of objects (Task)
isLive
boolean

Indicates if the item is available for selection

ts
string

The timestamp of the Sales Account encoded in Base64

id
string

The GUID representing the Sales Account in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "solicitedByUserId": "string",
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Accounts

This Sales Accounts endpoint returns information about Agencies and Advertisers, their Contacts, Opportunities, Calls, Meetings and Tasks.

The optional parameters may be used to filter and page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Account

This Sales Account endpoint returns information about an Agency or Advertiser, it's Contacts, Opportunities, Calls, Meetings and Tasks.

path Parameters
id
required
string

The ID of the Sales Account to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "solicitedByUserId": "string",
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Selectively updates fields in a Sales Account

Updates a Sales Account using the specified patch information. | One of the operations must have path of "/Ts" and the value must be the current timestamp.

path Parameters
id
required
string

The ID of the Sales Account to patch.

Request Body schema: application/json
Array
op
required
string
Enum: "add" "remove" "replace" "move" "copy" "test"

The operation to be performed

path
required
string

A JSON-Pointer

value
object

The value to be used within the operations.

from
string

A string containing a JSON Pointer value.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "solicitedByUserId": "string",
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Account

This Sales Account endpoint saves information about a new or updated Agency or Advertiser.

path Parameters
id
required
string

The ID of the Sales Account to add or update.

Request Body schema: application/json

Sales Account to be saved.

name
required
string

Name

additionalName
string

Additional Name

additionalName2
string

Additional Name 2

additionalName3
string

Additional Name 3

code
required
string

Code

businessTypeId
required
string

The ID of the Business Type: Agency: 00CB21B1-BC45-480A-9B87-140282242D6E Advertiser: AD263CA3-FC26-4AC3-B7FE-73FAE652BA8E

businessTypeName
string

Business Type Name

oid
string

A field not visible in the UI for storing external IDs

streetNumber
string

Street Number

address1
string

Address Line 1

address2
string

Address Line 2

city
string

City

postalCode
string

Postal/ZIP Code

countryId
string

An ID representing the Country in the database

stateId
string

An ID representing the State in the database

areaCode
string

The phone number's area code

phoneNumber
string

Phone Number

languageId
string

An ID representing the Language

languageName
string

Language

emailAddress
string

Email Address

clientTypeID
string

The ID of the account client type

assignedToUserId
string

The ID of the User the Sales Account is assigned to

assignedToUserName
string

The UserName of the User the Sales Account is assigned to

isLocked
boolean

Is Locked

canBeSolicited
boolean
Default: true

Indicates if the account can be solicited.

lat
number <double>

Latitude

lng
number <double>

Longitude

customProperty1
string

A custom value.

automaticallyApproveUploadedDesigns
boolean

Indicates that the designs for this sales account are automatically approved on upload

badCreditStatus
boolean

Indicates that the sales account has bad credit status and shouldn't be able to order

invoiceTermID
string

An ID representing the invoice term in the database

debtorCode
string

Debtor code that can be used to identify this sales account in financial backoffice

Array of objects (EntityProperty)

Contains finance related attributes. Available attribute names: 'VAT Obligation', 'VAT ID Number'

lastVisitedOnUtc
string <date-time>

The date in UTC the Business was last visited

lastVisitedByUserId
string

The ID of the User who last visited the Business

createdOnUtc
string <date-time>

The date in UTC the Sales Account was created

createdByUserId
string

The ID of the User who created the Sales Account

modifiedOnUtc
string <date-time>

The date in UTC the Sales Account was last modified

modifiedByUserID
string

The ID of the User who last modified the Sales Account

Array of objects (Contact)
Array of objects (Opportunity)
Array of objects (Activity)
Array of objects (Task)
isLive
boolean

Indicates if the item is available for selection

ts
string

The timestamp of the Sales Account encoded in Base64

id
string

The GUID representing the Sales Account in the database

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "additionalName": "string",
  • "additionalName2": "string",
  • "additionalName3": "string",
  • "code": "string",
  • "businessTypeId": "string",
  • "businessTypeName": "string",
  • "oid": "string",
  • "streetNumber": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "countryId": "string",
  • "stateId": "string",
  • "areaCode": "string",
  • "phoneNumber": "string",
  • "languageId": "string",
  • "languageName": "string",
  • "emailAddress": "string",
  • "clientTypeID": "string",
  • "assignedToUserId": "string",
  • "assignedToUserName": "string",
  • "isLocked": true,
  • "canBeSolicited": true,
  • "solicitedByUserId": "string",
  • "lat": 0,
  • "lng": 0,
  • "customProperty1": "string",
  • "automaticallyApproveUploadedDesigns": true,
  • "badCreditStatus": true,
  • "invoiceTermID": "string",
  • "debtorCode": "string",
  • "financeAttributes": [
    ],
  • "lastVisitedOnUtc": "2019-08-24T14:15:22Z",
  • "lastVisitedByUserId": "string",
  • "createdOnUtc": "2019-08-24T14:15:22Z",
  • "createdByUserId": "string",
  • "modifiedOnUtc": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": "string",
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "activities": [
    ],
  • "tasks": [
    ],
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Account

This Sales Account endpoint deletes an Agency or Advertiser.

path Parameters
id
required
string

The ID of the Sales Account to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Sales Contracts

Sales Contract

This Sales Contract endpoint returns a list of all Sales Contract Items associated with the supplied Sales Contract ID.

path Parameters
id
required
string

The ID of the Sales Contract to retrieve.

Responses

Response samples

Content type
application/json
{
  • "campaignID": "string",
  • "salesContractItemIDs": [
    ],
  • "ts": "string",
  • "id": "string"
}

Sales Contract Items

Sales Contract Item

This Sales Contract Item endpoint returns the details of a Sales Contract Item associated with the supplied Sales Contract Item ID.

path Parameters
id
required
string

The ID of the Sales Contract Item to retrieve.

Responses

Response samples

Content type
application/json
{
  • "salesContractID": "string",
  • "campaignID": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "salesMarketID": "string",
  • "description": "string",
  • "networkID": "string",
  • "mediaTypeGroupID": "string",
  • "mediaTypeID": "string",
  • "salesContractItemTypeID": "string",
  • "billingAmount": "string",
  • "purchaseTypeID": "string",
  • "rateCardValueID": "string",
  • "rateCardTypeID": "string",
  • "oid": "string",
  • "salesContractItemNumber": "string",
  • "pricingMethodID": "string",
  • "scheduleTemplateID": "string",
  • "spotLength": "string",
  • "programmaticDesignUrl": "string",
  • "goals": {
    },
  • "restrictions": {
    },
  • "digitalBookingLines": [
    ],
  • "ts": "string",
  • "id": "string"
}

Sales Market Cultures

Sales Market Culture

This endpoint saves information about a new Sales Market Culture.

Request Body schema: application/json

Sales Market Culture to be saved.

cultureName
string

The culture name (aka language) of this Sales Market Culture

name
string

The name of this Sales Market Culture

salesMarketID
string

The SalesMarketID with which this culture is associated

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "salesMarketID": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Sales Market Culture

This endpoint returns Sales Market Culture data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Market Culture

This endpoint returns information about Sales Market Cultures for a specific Sales Market

path Parameters
salesMarketId
required
string

The ID of the Sales Market whose cultures are to be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Market Culture

This endpoint saves information about an updated Sales Market Culture.

path Parameters
salesMarketId
required
string

The ID of the Sales Market whose cultures are to be updated.

Request Body schema: application/json

Sales Market Culture to be saved.

cultureName
string

The culture name (aka language) of this Sales Market Culture

name
string

The name of this Sales Market Culture

salesMarketID
string

The SalesMarketID with which this culture is associated

ts
string

The timestamp of the Sales Market Culture encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "cultureName": "string",
  • "name": "string",
  • "salesMarketID": "string",
  • "ts": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Sales Markets

Sales Market

This endpoint saves information about a new Sales Market.

Request Body schema: application/json

Sales Market to be saved.

code
required
string

Code

name
required
string

Name of Sales Market

companyId
required
string

The GUID representing the Company in the database

officeId
string

The GUID representing the related Office of the Company in the database

population
number

The number of population in the Sales Market

totalCirculation
number

The number of total circulation in the Sales Market

isLive
boolean

Indicates if the item is available for selection, by default is true.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Markets

This endpoint returns Sales Market reference data. The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Market

This endpoint returns information about a Sales Market

path Parameters
id
required
string

The ID of the Sales Market to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Market

This endpoint saves information about an updated Sales Market.

path Parameters
id
required
string

The ID of the Sales Market to update.

Request Body schema: application/json

Sales Market to be saved.

code
required
string

Code

name
required
string

Name of Sales Market

companyId
string

The GUID representing the Company in the database

officeId
string

The GUID representing the related Office of the Company in the database

population
number

The number of population in the Sales Market

totalCirculation
number

The number of total circulation in the Sales Market

isLive
boolean

Indicates if the item is available for selection

ts
string

The timestamp of the Sales Market encoded in Base64

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true,
  • "ts": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "companyId": "string",
  • "officeId": "string",
  • "population": 0,
  • "totalCirculation": 0,
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Sales Stages

Sales Stages

This Sales Stages endpoint returns Sales Stage reference data.

The optional parameters may be used to page through the available records.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales Stage

This Sales Stages endpoint returns information about a Sales Stage

path Parameters
id
required
string

The ID of the Sales Stage to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "ts": "string",
  • "id": "string"
}

Salutations

Salutations

This Salutation endpoint saves information about a new or updated salutation.

Request Body schema: application/json

Salutation to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Indicates if the item is available for selection

ts
string

The timestamp of the Contact encoded in Base64

id
string

The GUID representing the Contact in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Salutations

This Salutation endpoint returns information about available salutations.

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Salutations

This Salutation endpoint returns information about available salutations.

path Parameters
id
required
string

The ID of the Salutation to retrieve.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Salutations

This Salutation endpoint saves information about a new or updated salutation.

path Parameters
id
required
string

The ID of the Salutation to add or update.

Request Body schema: application/json

Salutation to be saved.

code
required
string

Code

name
required
string

Name

isLive
required
boolean

Indicates if the item is available for selection

ts
string

The timestamp of the Contact encoded in Base64

id
string

The GUID representing the Contact in the database

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "isLive": true,
  • "ts": "string",
  • "id": "string"
}

Salutation

This Salutation endpoint deletes a salutation.

path Parameters
id
required
string

The ID of the Salutation to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Sessions

Sign in

Signs in using the specified username and password. Usage: /sessions/signin?username=USERNAME&password=PASSWORD where USERNAME and PASSWORD should be replaced with your login credentials.

query Parameters
username
required
string

The username

password
required
string

The password

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Sign out

Signs out

query Parameters
sessionId
string <uuid>

Not used. Can be safely ignored when sending requests to this action method. Legacy parameter kept only to avoid breaking old API clients.

Responses

Response samples

Content type
application/json
true

Simple Faces

Simple Faces

This endpoint returns simple information about all Faces

  • The optional parameters may be used to filter the results.
query Parameters
adServedOnly
required
boolean

a filter to decide if only ad-serving Faces should be included in the response

noStatic
boolean

a filter to decide if static Faces should be excluded in the response

noVirtual
boolean

a filter to decide if virtual Faces should be excluded in the response

timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

includeOperatingHours
boolean

a flag to decide if operating hours of the Face should be fetched

fields
string

Comma-separated list all fields to include in the results

adServingPeriodFromNowInDays
number <integer>

a period in number of days within which the Faces are ad-serving. This parameter works with adServedOnly parameter. The response will return Faces that are ad-serving from today to (today + adServingPeriodFromNowInDays). The value defaults to 7. The value 0 would query for all ad-serving faces from now on.

Responses

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "networkID": "string",
  • "mediaTypeGroupID": "string",
  • "mediaTypeID": "string",
  • "number": "string",
  • "description": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "canvasLayoutWidth": 0,
  • "canvasLayoutHeight": 0,
  • "retiredAsOfDate": "2019-08-24T14:15:22Z",
  • "isSaleable": true,
  • "operatingHours": [
    ],
  • "ts": "string",
  • "id": "string"
}

Simple Faces

This endpoint returns simple information about a specified Face

  • The optional parameters may be used to filter the result.
path Parameters
id
required
string

The ID of the Face to retrieve

query Parameters
includeOperatingHours
required
boolean

a flag to decide if operating hours of the Face should be fetched

fields
string

Comma-separated list all fields to include in the results

timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

Responses

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "networkID": "string",
  • "mediaTypeGroupID": "string",
  • "mediaTypeID": "string",
  • "number": "string",
  • "description": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "canvasLayoutWidth": 0,
  • "canvasLayoutHeight": 0,
  • "retiredAsOfDate": "2019-08-24T14:15:22Z",
  • "isSaleable": true,
  • "operatingHours": [
    ],
  • "ts": "string",
  • "id": "string"
}

Face

This endpoint returns information about faces that belong to specific sites

  • optional parameters may be used to filter the results
query Parameters
noStatic
boolean

a filter to decide if static Faces should be included in the response

noVirtual
boolean

a filter to decide if virtual Faces should be included in the response

includeOperatingHours
boolean

a flag to decide if operating hours of the Faces should be fetched

adServedOnly
boolean

a filter to decide if only ad-serving Faces should be included in the response

adServingPeriodFromNowInDays
integer

a period in number of days within which the Faces are ad-serving. This parameter works with adServedOnly parameter. The response will return Faces that are ad-serving from today to (today + adServingPeriodFromNowInDays). The value defaults to 7. The value 0 would query for all ad-serving faces regardless of when they are ad-serving.

saleableOnly
boolean

a filter to decide if only saleable Faces should be included in the response

Request Body schema: application/json

IDs of the sites to get information about the Faces from

Array
string

GUID of a site

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "networkID": "string",
  • "mediaTypeGroupID": "string",
  • "mediaTypeID": "string",
  • "number": "string",
  • "description": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "canvasLayoutWidth": 0,
  • "canvasLayoutHeight": 0,
  • "retiredAsOfDate": "2019-08-24T14:15:22Z",
  • "isSaleable": true,
  • "operatingHours": [
    ],
  • "ts": "string",
  • "id": "string"
}

Face

This endpoint returns information about Faces with the mentioned ids.

Request Body schema: application/json

The IDs of the Faces to retrieve.

ids
string

An Array Of Guids

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Sites

Site

This endpoint returns information about Sites with the mentioned ids.

Request Body schema: application/json

The IDs of the Sites to retrieve.

ids
string

An Array Of Guids

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Site Design Restrictions

Site Design Restriction

This endpoint saves information about a new Site Design Restriction.

Request Body schema: application/json

Site Design Restriction to be saved.

siteID
required
string

The GUID representing the Site in the database

designRestrictionID
required
string

The GUID representing the Reason of restriction in the database

Responses

Request samples

Content type
application/json
{
  • "siteID": "string",
  • "designRestrictionID": "string"
}

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Site Design Restrictions

This endpoint returns information about all Site Design Restrictions.

  • The optional parameters may be used to filter and page through the available records.
query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

fields
string

Comma-separated list all fields to include in the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Site Design Restriction

This endpoint returns information about a Site Design Restriction.

path Parameters
id
required
string

The ID of the Site Design Restriction to retrieve.

Responses

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

SiteDesignRestriction

This endpoint edit information about an updated Site Design Restriction.

path Parameters
id
required
string

The ID of the Site Design Restriction to update.

Request Body schema: application/json

Site Design Restriction to be saved.

siteID
required
string

The GUID representing the Site in the database

designRestrictionID
required
string

The GUID representing the Reason of restriction in the database

ts
string

The timestamp of the SiteDesignRestriction encoded in Base64

id
string

The GUID representing the SiteDesignRestriction in the database

Responses

Request samples

Content type
application/json
{
  • "siteID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "siteID": "string",
  • "designRestrictionID": "string",
  • "ts": "string",
  • "id": "string"
}

Users

User

This endpoint saves information about a new User. Note: In order to POST a new user a sessionID is required! This can be obtained through the /sessions/signin endpoint (information can be found in this document). It should be included in the header with the key sessionID when POSTing to /users.

Request Body schema: application/json

User to be saved.

firstName
required
string

First name

lastName
required
string

Last name

email
string

Email address

userName
string

User name

password
string

Password (never returned by the api)

confirmPassword
string

Password confirmation (never returned by the api)

workPhoneNumber
string

Work phone number

jobTitleId
required
string

The ID of the users's JobTitle

title
string

Title

salutation
string

Salutation

code
required
string

Code

isLive
required
boolean

Indicates if the user is active

popUploadAccessTypeID
string

PopUploadAccessTypeID

pictureFileID
string

PictureFileID

pictureThumbnail
string

PictureThumbnail

ts
string

The timestamp of the User encoded in Base64

id
string

The GUID representing the User in the database

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

Users

This endpoint returns information about Users.

  • The optional parameters may be used to filter and page through the available records.

  • Sorting: Field names must be capitalized (e.g. LastName).

Example usage with sort and filter: /Ayuda.BMS.Api/v2/users?sort=LastName&filters=[{"prop":"firstName","val":"John"},{"prop":"lastName","val":"D"}]

query Parameters
timestamp
string <string>

If provided, only records with later timestamps are returned. The value must be a Base64 encoded timestamp.

skip
number <integer>

Number of records to skip.

take
number <integer>

Number of records to return.

sort
string

Name of the field the result should be sorted by. The sort is ascending by default, becomes descending if the name of the field is preceeded by a '-'.

search
string

Free text used to filter the results. Typically all text fields will be searched.

fields
string

Comma-separated list all fields to include in the results.

filters
string

Array of property/value pairs, where "prop" is the field to filter, and "value" is the string to filter by.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

User

This endpoint returns information about a User.

path Parameters
id
required
string

The ID of the User to retrieve.

Responses

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

Selectively updates fields for a User

Updates a User using the specified patch information. | One of the operations must have path of "/Ts" and the value must be the current timestamp.

path Parameters
id
required
string

The ID of the User to patch.

Request Body schema: application/json
Array
op
required
string
Enum: "add" "remove" "replace" "move" "copy" "test"

The operation to be performed

path
required
string

A JSON-Pointer

value
object

The value to be used within the operations.

from
string

A string containing a JSON Pointer value.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

User

This endpoint saves information about a new or updated User.

path Parameters
id
required
string

The ID of the User to add or update.

Request Body schema: application/json

User to be saved.

firstName
required
string

First name

lastName
required
string

Last name

email
string

Email address

userName
string

User name

password
string

Password (never returned by the api)

confirmPassword
string

Password confirmation (never returned by the api)

workPhoneNumber
string

Work phone number

jobTitleId
required
string

The ID of the users's JobTitle

title
string

Title

salutation
string

Salutation

code
required
string

Code

isLive
required
boolean

Indicates if the user is active

popUploadAccessTypeID
string

PopUploadAccessTypeID

pictureFileID
string

PictureFileID

pictureThumbnail
string

PictureThumbnail

ts
string

The timestamp of the User encoded in Base64

id
string

The GUID representing the User in the database

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "userName": "string",
  • "password": "string",
  • "confirmPassword": "string",
  • "workPhoneNumber": "string",
  • "jobTitleId": "string",
  • "title": "string",
  • "salutation": "string",
  • "code": "string",
  • "isLive": true,
  • "popUploadAccessTypeID": "string",
  • "pictureFileID": "string",
  • "pictureThumbnail": "string",
  • "ts": "string",
  • "id": "string"
}

User

This endpoint deletes a User.

path Parameters
id
required
string

The ID of the User to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "fields": "string"
}

Playlogs

Gets Playlogs for the Specified Date and FaceIDs

This Playlog endpoint retrieves a playlog summary for the face ids provided on a specified day

Request Body schema: application/json

Face IDs and a Date

faceIds
required
string

A comma separated string of Face Ids

startTime
date

Optional start date to query playlogs from in ISO 8601 format (yyyy-MM-dd), defaults to yesterday.

Responses

Request samples

Content type
application/json
{
  • "faceIds": "string",
  • "startTime": null
}

Response samples

Content type
application/json
[
  • {
    }
]