Person Transactions

The web service provides access to the basic person transactions, though note these are restricted solely to the creation of Users. These include creating, updating, deleting and retrieving User deta

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

Even though these transactions are restricted to Users, person transactions use a prefix of Person instead of User, as Person is the term the API must pass through to be recognized by the ASM app.

The API has a messaging transaction to email stakeholders linked to a person. See MessageStakeHolders Transaction for more information.

PersonCreate Transaction

The PersonCreate transaction creates a person record flagged as a User and saves it in the database.

Input Parameters: PersonCreateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Ignored

-

Ignored on create

sTitle

String

No

“”

User Title

sUserID

String

No

“”

User Login ID. This must be a unique login.

sPassword

String

No

“”

User Password

lEmailFormat

Lookup Field

No

System’s default email setting

User’s preferred Email format. Values:

1 = Plain Text

2 = HTML

3 = Related HTML

sEmail

String

No

“”

User’s Email ID

sFirstName

String

No

“”

User First Name

sJobTitle

String

No

“”

User Job Title

sSurname

String

No

“”

User Surname

sTelephone

String

No

“”

User Telephone number

sMobile

String

No

“”

User Cell number

lLocation

Lookup Field

No

0

User Location

lOrganization

Lookup Field

No

0

User Organization

lPortalRole

Lookup Field

No

0

Self Service Portal Role assigned to this User

lProfile

Lookup Field

No

0

User Profile

lServiceLevel

Lookup Field

No

0

User Service Level

lVIPStatus

Lookup Field

No

0

User VIP Status

bAccountDisabled

Boolean

No

False

Indicate whether this User account is disabled. Values:

  • True = User’s account is disabled

  • False = User’s account is active

bPortal

Boolean

No

False

Flag if this person has Self Service Portal access. Values:

  • True = person has Portal access

  • False = person does not have Portal access

bTemplate

Boolean

No

False

Flag whether this Person record is a template. Values:

  • True = flag this Person record as a template

  • False = do not flag this Person record as a template

lPartition

Lookup Field

No

Analyst’s default partition

Partition assigned to the User

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values:PersonResponse

Argument

Type

Description

nEntityRef

Integer

Newly created person ref

sMessage

String

Error/Warning message returned from API Transaction

Ret

APIReturn

Error/Warning Number returned from API Transaction.

PersonUpdate Transaction

The PersonUpdate transaction can be used to update the details of any person record. The person record to update must be flagged as a User.

Input Parameters: PersonUpdateRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Person Record to update

sTitle

String

No

(As Is)

User Title

sUserID

String

No

(As Is)

User Login ID. This must be a unique login.

sPassword

String

No

(As Is)

User Password

lEmailFormat

Lookup Field

No

(As Is)

User’s preferred Email format. Values:

1 = Plain Text

2 = HTML

3 = Related HTML

sEmail

String

No

(As Is)

User’s Email ID

sFirstName

String

No

(As Is)

User First Name

sJobTitle

String

No

(As Is)

User Job Title

sSurname

String

No

(As Is)

User Surname

sTelephone

String

No

(As Is)

User Telephone number

sMobile

String

No

(As Is)

User Cell number

lLocation

Lookup Field

No

(As Is)

User Location

lOrganization

Lookup Field

No

(As Is)

User Organization

lPortalRole

Lookup Field

No

(As Is)

Self Service Portal Role assigned to this User

lProfile

Lookup Field

No

(As Is)

User Profile

lServiceLevel

Lookup Field

No

(As Is)

User Service Level

lVIPStatus

Lookup Field

No

(As Is)

User VIP Status

bAccountDisabled

Boolean

No

(As Is)

Indicate whether this User account is disabled. Values:

  • True = User’s account is disabled

  • False = User’s account is active

bPortal

Boolean

No

(As Is)

Flag if this person has Self Service Portal access. Values:

  • True = person has Portal access

  • False = person does not have Portal access

bTemplate

Boolean

No

(As Is)

Flag whether this Person record is a template. Values:

  • True = flag this Person record as a template

  • False = do not flag this Person record as a template

lPartition

Lookup Field

No

(As Is)

Partition assigned to the User

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: PersonResponse

See PersonResponse for more information.

PersonRetrieve Transaction

The PersonRetrieve transaction can be used to return the details of a Person record. This person must be flagged as a User.

Input Parameters: PersonEntityRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Person Record to update

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: PersonRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning number returned from API Transaction

sMessage

String

Error/Warning message returned from API Transaction

ResultSet

DataSet

ResultSet containing attribute details

PersonDelete Transaction

The PersonDelete transaction can be used to locate and delete a person record. This person record must be flagged as a User. This transaction updates the status and audit trail fields.

Input Parameters: PersonDeleteRequest

Argument

Type

Mandatory

Default

Description

sID

String

No. See Transaction Login.

“”

Analyst’s current Session ID

sLoginUserID

String

No. See Transaction Login.

“”

Analyst’s Login ID

sLoginPassword

String

No. See Transaction Login.

“”

Analyst’s Password

sDatabase

String

No. See Transaction Login.

“”

Name of the ASM System for logging in.

lEntityRef

Lookup Field

Yes

-

Reference number of the Person Record to update

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: PersonResponse

See PersonResponse for more information.

Copyright 2023 Alemba, ASM EOS 10.4