Clients


Client Id

Display detailed information about a client.

 

GET URL: http:/{endpoint}/client/{Client Id}

API Callhttp://apiv1.scribblelive.com/client/{Client Id}/?Token={Api Token}&Auth={Authentication Key}&Format=json

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string  Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

 

…………………………………………………………………………………………………………………..

Recent Client Events

Displays up to {How many} recent events in that client.

 

GET URL: http:/{endpoint}/client/{Client Id}/events

API Call: http://apiv1.scribblelive.com/client/{Client Id}/events/?Token={Api Token}&Max={How many}&Auth={Authentication Key}&Format=json

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Max integer The maximum number of posts,comments,etc that should be returned.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Create New Client Event

Create a new event in the client context, with the parameters.

 

GET URL: http:/{endpoint}/client/{Client Id}/create

API Call: http://apiv1.scribblelive.com/client/{Client Id}/create/?Token={Api Token}&Title={Title}&Description={Description}&IsModerated={0/1}&IsCommenting={0/1}&Start={Start date/time}&End={End date/time}&Auth={Authentication Key}&Format=json

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Title true string The title of the event.
Description string The description of the event.
IsModerated integer Determines whether posts coming into an event go through moderation {1} or automatically approved{0} to the liveblog. The value is a boolean where {1} represents true and {0} represents false.
IsCommenting integer Determines whether the event allows commenting or read-only. If commenting is enabled viewers can login anonymously to participate. The value is a boolean where {1} represents true and {0} represents false.
Start datetime The date and time the event should start on. The timestamp must be in UTC and in the format 2011/09/29 15:11:53
End datetime The date and time the event should end on. The timestamp must be in UTC and in the format 2011/09/29 15:11:53
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Live Client Events

Displays up to {How many} live events in that client.

 

GET URL: http:/{endpoint}/client/{Client Id}/events/live

API Call: http://apiv1.scribblelive.com/client/{Client Id}/events/live/?Token={Api Token}&Max={How many}&Auth={Authentication Key}&Format=json

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Max integer The maximum number of posts,comments,etc that should be returned.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

 

…………………………………………………………………………………………………………………..

User’s Invited Events

Displays up to {How many} of the authenticated user’s invited events.

 

GET URL: http:/{endpoint}/client/{Client Id}/events/user

API Call: http://apiv1.scribblelive.com/client/{Client Id}/events/user/?Token={Api Token}&Max={How many}&Auth={Authentication Key}&Format=json

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Max integer The maximum number of posts,comments,etc that should be returned.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

 

…………………………………………………………………………………………………………………..

Live & Upcoming Client Events

Displays up to {How many} live and upcoming events in that client.

 

GET URL: http:/{endpoint}/client/{Client Id}/events/liveandupcoming

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Category Id integer The category id you would like to filter by.
Max integer The maximum number of posts,comments,etc that should be returned.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with

 

…………………………………………………………………………………………………………………..

Client Events with Meta Data

Displays up to {How many} of the authenticated user’s events that contain meta data that matches the given filter.

 

GET URL: http:/{endpoint}/client/{Client Id}/events/withmeta

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Filter true string JSON encoded hash of meta keys/values to filter on
CategoryId integer The category id you would like to filter by
Max integer The maximum number of posts,comments,etc that should be returned.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with

…………………………………………………………………………………………………………………..

Client Websites

Displays up to {How many} recent articles in that client.

 

GET URL: http:/{endpoint}/client/{Client Id}/websites/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with

…………………………………………………………………………………………………………………..

Client Articles

Get a list of websites associated with the client.

 

GET URL: http:/{endpoint}/client/{Client Id}/articles/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Category Id integer The category id you would like to filter by.
Max integer The maximum number of posts,comments,etc that should be returned.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with

 

…………………………………………………………………………………………………………………..

Client Categories

Get a list of categories associated with the client.

 

GET URL: http:/{endpoint}/client/{Client Id}/categories/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with


…………………………………………………………………………………………………………………..

Client Lead Captures

Get a list of lead capture types associated with the client.

 

GET URL: http:/{endpoint}/client/{Client Id}/leadcapturetypes/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with


…………………………………………………………………………………………………………………..

Client Polls

Get a list of polls associated with the client.

 

GET URL: http:/{endpoint}/client/{Client Id}/polls/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with

 

…………………………………………………………………………………………………………………..

Client Content Goals

Get a list of content goals associated with the client.

 

GET URL: http:/{endpoint}/client/{Client Id}/contentgoals/list

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Client Id true integer The ID of the client being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with