LearningTagCandidateService Types

LearningTagCandidateService WSDL


This service is stateless.

addCandidateToBlacklisttop

Description

Requires admin rights.

boolean addCandidateToBlacklist(int $candidate_id)

Parameters

int $candidate_id

Return Values

boolean True on success, otherwise false

getBlacklistedCandidatestop

Description



LearningTagCandidateList getBlacklistedCandidates()

Return Values

LearningTagCandidateList

getCandidatestop

Description



LearningTagCandidateList getCandidates()

Return Values

LearningTagCandidateList

logintop

Description

Initializes a new session with given information

boolean login(string $user, string $pass, int $network)

Parameters

string $user Username
string $pass Password
int $network $network Network ID

Return Values

boolean true on success, false on fail

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean true on success, false on fail

removeCandidateFromBlacklisttop

Description

Requires admin rights.

boolean removeCandidateFromBlacklist(int $candidate_id)

Parameters

int $candidate_id

Return Values

boolean True on success, otherwise false

LearningTagCandidatetop

Definition

object LearningTagCandidate {
- int $id

required

- int $adRequests

required

- string $createdAt

required

- string $updatedAt

required

- int $contentunitId

optional

- Array <LearningTagCandidateAttribute> $attributes

required

}

LearningTagCandidateAttributetop

Definition

object LearningTagCandidateAttribute {
- string $name

required

- string $value

required

}

LearningTagCandidateListtop

Definition

object LearningTagCandidateList {
- Array <LearningTagCandidate> $candidates

optional

}

Console