AuthenticationServiceSoap

Operations

Index Method Parameters Response Type Description
1 getUserToken
username
password
String Provides an authentication token that is used in all methods that require authenticated user context.
2 getOrganizationToken
user
password
String Same as getUserToken
3 updateUser
userToken
usernameToUpdate
name
emailAddress
Updates details of a staff member if that person is not associated with any other organizations.
4 changePassword
userToken
username
oldPassword
newPassword
Updates password of a staff member if that person is not associated with any other organizations.
5 createWriterAccount
userToken
name
username
password
Creates a new staff member in the writer role.
6 createWriterAccountWithResult
userToken
name
username
password
CreateWriterAccountResult Same as createWriterAccount, but returns a result indicating if the user already existed in the system.
7 getAvailableOrganizations
userToken
ArrayOfOrganizationInfo Returns all organizations that the authenticated user is associated with.
8 switchOrganization
userToken
organizationId
String Creates a token that is specific to the currently authenticated user within the provided organization.
9 getCustomerToken
organizationToken
customerEmail
customerPassword
String Returns a token for a customer that can be used to look up events specifically for them.
10 validateUserForEvent
eventToken
userToken
KeyValuePair Determines wether a specific user is allowed to view an event.
12 removeUser
userToken
usernameToDelete
Removes the staff member from the organization.

getUserToken

Parameters

Name Type Required Description
username
String
 Y
password
String
 Y

Response

Name Type Required Description
GetUserTokenResult
String
 Y

getOrganizationToken

Parameters

Name Type Required Description
user
String
 Y
password
String
 Y

Response

Name Type Required Description
GetOrganizationTokenResult
String
 Y

updateUser

Parameters

Name Type Required Description
userToken
String
 Y
usernameToUpdate
String
 Y
name
String
 Y
emailAddress
String
 Y

Response

No Response

changePassword

Parameters

Name Type Required Description
userToken
String
 Y
username
String
 Y
oldPassword
String
 Y
newPassword
String
 Y

Response

No Response

createWriterAccount

Parameters

Name Type Required Description
userToken
String
 Y
name
String
 Y
username
String
 Y
password
String
 Y

Response

No Response

createWriterAccountWithResult

Parameters

Name Type Required Description
userToken
String
 Y
name
String
 Y
username
String
 Y
password
String
 Y

Response

Name Type Required Description
CreateWriterAccountWithResultResult
CreateWriterAccountResult
Property Type Required Description
Success Boolean Y
Existing Boolean Y
Y

getAvailableOrganizations

Parameters

Name Type Required Description
userToken
String
 Y

Response

Name Type Required Description
GetAvailableOrganizationsResult
ArrayOfOrganizationInfo
Property Type Required Description
OrganizationInfo[] OrganizationInfo[] N
OrganizationInfo[].Id String N
OrganizationInfo[].LegalName String N
Y

switchOrganization

Parameters

Name Type Required Description
userToken
String
 Y
organizationId
String
 Y

Response

Name Type Required Description
SwitchOrganizationResult
String
 Y

getCustomerToken

Parameters

Name Type Required Description
organizationToken
String
 Y
customerEmail
String
 Y
customerPassword
String
 Y

Response

Name Type Required Description
GetCustomerTokenResult
String
 Y

validateUserForEvent

Parameters

Name Type Required Description
eventToken
String
 Y
userToken
String
 Y

Response

Name Type Required Description
ValidateUserForEventResult
KeyValuePair
Property Type Required Description
Key String N
Value String N
Y

removeUser

Parameters

Name Type Required Description
userToken
String
 Y
usernameToDelete
String
 Y

Response

No Response