GetList

This call will load different kind of lists. The response will contain a static array of subordinated list items for the type that is requested. The response will contain header information and presentation information. As default, the header information will be "Name", otherwize the header information will be customized depending on configuration (e.g. "Name|Email|DateTime").

Input parameters

Input-SessionId: The current session id as base64-string. This type is mandatory.
Input-Type: The type of list to be requested. This type is mandatory.
Input-EntityType: Optional type of entity for specific types. This type is only mandatory for specific entity objects.
Input-Id: The id of an entity object. This type is only mandatory for specific entity objects.
Input-Count: The current call-count of the session. This must be a numeric value. This type is mandatory.

Output parameters

Output-ResultCounter: The number of items in the list.
Output-HeaderInfo: The information of headers as a pipe-separated string (default "Name").
Output-List[].ListObj: The array list with subordinated items.
Output-List[].ListObj.Id: The unique id if the list item (e.g. the id of a user, reference to an object etc.).
Output-List[].ListObj.OriginServiceType: The type of the origin service for the item. This type is typical specified as Internal but can also be other kind of service types (e.g. MSAD if the item is loaded from Microsoft Active Directory).
Output-List[].ListObj.PresentationInfo: The value of the item to be presented by the client. The value could be either a single value or a pipe-separated value.
Output-List[].ListObj.AdditionalInfo: The optional additional information that can be used by the client for some types. For example, when loading a list of reports, some reports must include time interval argument(s) when loading the report object though GetObject metod. Some reports does not require this. The indication from server will therefore be: FieldName=StartDateTime,FieldType=DateTime|FieldName=EndDateTime,FieldType=DateTime
This example indicates that the report must have two input field arguments named "StartDateTime" and "EndDateTime" with the type "DateTime" for the client to present the possibility to use time intervals for the report.
Output-List[].ListObj.ActivityList: The generic activity list that can be used by the client for some types.

SOAP implementation

Content type

text/xml; charset="utf-8";

Header

Action: "http://www.pointsharp.com/netid/server/portal/IServiceSoap/GetList"

Request (single values)

<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetList xmlns="http://www.pointsharp.com/netid/server/portal">
            <Info>
                <SessionId></SessionId>
                <Type>UserGroup</Type>
                <Count>1</Count>
            </Info>
        </GetList>
    </s:Body>
</s:Envelope>

Response (single values)

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <GetListResponse xmlns="http://www.pointsharp.com/netid/server/portal">
            <GetListResult>
                <ResultCounter>3</ResultCounter>
                <HeaderInfo>Name</HeaderInfo>
                <List>
                    <ListObj>
                        <Id>1</Id>
                        <OriginServiceType>Internal</OriginServiceType>
                        <PresentationInfo>Users</PresentationInfo>
                    </ListObj>
                    <ListObj>
                        <Id>2</Id>
                        <OriginServiceType>Internal</OriginServiceType>
                        <PresentationInfo>Administrators</PresentationInfo>
                    </ListObj>
                    <ListObj>
                        <Id>3</Id>
                        <OriginServiceType>Internal</OriginServiceType>
                        <PresentationInfo>SuperAdmin</PresentationInfo>
                    </ListObj>
                </List>
                <Status>
                    <Code>Success</Code>
                    <Description>Success</Description>
                </Status>
            </GetListResult>
        </GetListResponse>
    </s:Body>
</s:Envelope>

Request (dynamic values)

<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetList xmlns="http://www.pointsharp.com/netid/server/portal">
            <Info>
                <SessionId></SessionId>
                <Type>ActiveUser</Type>
                <Count>1</Count>
            </Info>
        </GetList>
    </s:Body>
</s:Envelope>

Response (dynamic values)

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <GetListResponse xmlns="http://www.pointsharp.com/netid/server/portal">
            <GetListResult>
                <ResultCounter>2</ResultCounter>
                <HeaderInfo>Name|Email|IdleDateTime</HeaderInfo>
                <List>
                    <ListObj>
                        <Id>5</Id>
                        <OriginServiceType>Internal</OriginServiceType>
                        <PresentationInfo>John Doe|john.doe@contoso.com|2023-01-01 08:59:02</PresentationInfo>
                    </ListObj>
                    <ListObj>
                        <Id>8</Id>
                        <OriginServiceType>Internal</OriginServiceType>
                        <PresentationInfo>John Ingram|john.ingram@contoso.com|2023-01-01 09:12:11</PresentationInfo>
                    </ListObj>
                </List>
                <Status>
                    <Code>Success</Code>
                    <Description>Success</Description>
                </Status>
            </GetListResult>
        </GetListResponse>
    </s:Body>
</s:Envelope>

REST implementation

Content type

application/json; charset="utf-8";

Method

POST

URI

/api/list/get

Request (static single values)

{
    "SessionId": "",
    "Type": "UserGroup",
    "Count": "1"
}

Response (static single values)

{
    "ResultCounter": "3",
    "List": [
        {
            "Id": "1",
            "OriginServiceType": "Internal",
            "PresentationInfo": "Users"
        },
        {
            "Id": "2",
            "OriginServiceType": "Internal",
            "PresentationInfo": "Administrators"
        },
        {
            "Id": "3",
            "OriginServiceType": "Internal",
            "PresentationInfo": "SuperAdmin"
        }
    ],
    "Status": {
        "Code": "Success",
        "Description": "Success"
    }
}

Request (dynamic values)

{
    "SessionId": "",
    "Type": "ActiveUser",
    "Count": "1"
}

Response (dynamic values)

{
    "ResultCounter": "2",
    "HeaderInfo": "Name|Email|IdleDateTime",
    "List": [
        {
            "Id": "5",
            "OriginServiceType": "Internal",
            "PresentationInfo": "John Doe|john.doe@contoso.com|2023-01-01 08:59:02"
        },
        {
            "Id": "8",
            "OriginServiceType": "Internal",
            "PresentationInfo": "John Ingram|john.ingram@contoso.com|2023-01-01 09:12:11"
        }
    ],
    "Status": {
        "Code": "Success",
        "Description": "Success"
    }
}

Available types

ActiveUser

Returns a list of available logged in users in the system.

AdditionalIdentity

This call requires EntityType and Id.

User: Returns a list with additonal identities of a user.
Token: Returns a list with additional identities of a token.
EndEntity: Returns a list with additional identities of a end antity.

AsymmetricAlgorithm

Returns a list of asymmetric algorithms. Available types are: RSA, ECDSA and ECDH.

AuditLogCritera

Returns a list of criteria when search against audit log.

AuditLogEvent

Returns a list of log events when search against audit log. This should be the generic task type list of events (e.g. CreateUser, CreateToken, UpdateUser etc. etc.).

AuditLogLevel

Returns a list of log levels when search against audit log. Available levels are: Cancelled, Completed, Executed, ExecutedFunction, Failed, Initialized, Rejected, Released, TimedOut and Warning.

AvailableOrganization

Returns a list of available organizations if available.

Boolean

Returns a list of boolean condition. Available types are: True and False.

Certificate

This call requires EntityType and Id.

User: Returns a list of certificates of a user.
Token: Returns a list of certificates of a token.
EndEntity: Returns a list of certificates of a end entity.

CertificateAuthority

Returns a list of available certificate authorities.

CertificateAuthorityEnrollmentMode

Returns a list of certificate authority enrollment mode types. Available types are: AgentSigner, Modifier and Stamp.

CertificateAuthorityManufacturer

Returns a list of certificate manufacturers. Available types are: MSCA, EJBCA and InternalCA.

CertificateEnrollmentType

Returns a list of certificate enrollment types. Available types are: FromInput, FromRequest and FromTemplate.

CertificateIssuanceType

Returns a list of certificate issuance types. Available types are: GenerateNewKey and UseExistingKey.

CertificateReferenceType

Returns a list of certificate reference types. Available types are: User, EndEntity, External and ManufacturerDatabase.

CertificateRevocationReason

Returns a list of certificate revocation reason types. Available types are: AaCompromise, AffiliationChanged, CACompromise, CertificateHold, CessationOfOperation, KeyCompromise, PrivilegeWithdrawn, Superseded and Unspecified.

CertificateTemplate

Returns a list of available certificate templates.

CitizenService

Returns a list of available citizen services.

CitizenServiceManufacturer

Returns a list of citizen service manufacturers. Available types are: SwedishTaxAgencyNavet and SwedishTaxAgencySPAR.

ContactlessService

Returns a list of available contactless services.

ContactlessServiceManufacturer

Returns a list of contactless services manufacturers. Available types are: PaperCut.

DateTimeType

Returns a list of date time types. Available types are: Seconds, Minutes, Hours, Days, Weeks, Months and Years.

DiagnosticLogCriteria

Returns a list of criterias when search against diagnostic log.

DirectoryService

Returns a list of available directory services.

DirectoryServiceManufacturer

Returns a list of directory service manufacturers. Available types are:

MSAD
MSADLDS
EntraID

EmploymentType

Returns a list of employment types. Available types are:

Consultant
ConsultantTermination
Other
PermanentContract
Termination

EndEntityStatus

Returns a list of end entity status types. Available types are:

Active
Inactive
Expired
Revoked
Unused

EndEntityType

Returns a list of end entity types. Available types are:

Active
Computer
Service

Language

Returns a list of available languages based on available text resources in the system.

LanguageStatic

Returns a distinct list of available languages based on available text resources in the system.

Office

Returns a list of available offices.

OfficeRestrictionAssigned

Returns a list of assigned restriced offices for a user. This call requires the Id argument.

Organization

Returns a list of available organizations.

OrganizationCertificate

Returns a list of available organization certificates.

PersonAppearanceEyeColor

Returns a list of eye color types for person appearance. Available types are:

Blue
DarkBrown
DifferentColored
Gray
Green
LightBrown
Marbled
Yellowish

PersonAppearanceHairColor

Returns a list of eye color types for person appearance. Available types are:

Bald
Black
Brown
DarkBlond
Gray
Grizzled
LightBlond
MediumBlond
Red
White

PersonIdentificationType

Returns a list of identification types for person appearance. Available types are:

BusinessCard
Document
DrivingLicense
EnterpriseServiceCard
ForeignIdentityDoc
Known
NationalIdentityCard
Passport
SISIdentityCard
SwedishTaxAgencyIdentityCard

PublicKeyAlgorithm

Returns a list of public key algorithms. Available types are: RSA and ECC.

Report

Returns a list of available reports.

Role

Returns a list of available roles. If using the Id argument, the system will return a list of available roles of a user.

ShortMessageService

Returns a list of short message services (SMS).

SMTPService

Returns a list of SMTP services.

SortOrder

Returns a list of sort order types. Available types are: Ascending and Descending.

TaskType

This call requires EntityType and Id.

User: Returns a list of available task types of a user.
Token: Returns a list of available task types of a token.
EndEntity: Returns a list of available task types of a end entity.

TextAgreement

This call requires EntityType and Id arguments.

User: Returns a list of available and saved text agreements of a user.

Token

This call requires Id argument. Returns a list of available tokens of a user.

TokenHistorical

This call requires Id argument. Returns a list of available historical tokens of a user.

TokenManufacturer

Returns a list of available token manufacturers.

TokenManufacturerType

Returns a list of token manufacturer types. Available types are: Thales.

TokenManufacturerArticle

Returns a list of available token manufacture articles.

TokenManufacturerArticleType

Returns a list of token manufacture article types. Available types are: Accessories, Other, Reader and Token.

TokenManufacturerArticleOrderType

Returns a list of token manufacture article order types. Available types are: PersonalizedToken, NonPersonalizedToken and PersonalizedTokenCodeLetter.

TokenProfile

Returns a list of available token profiles.

TokenStatus

Returns a list of token status types. Available types are: Active, Expired, Retired, Revoked, Unused, WaitForDistribution and WaitForExternalObject.

TokenStatusAdditional

Returns a list of additional token status types used when block a token. Available types are: Broken, BrokenChip, BrokenContactless, BrokenPhysical, DeleteToken, KeyCompromised, Lost, Other, Returned and Stolen.

TokenType

Returns a list of token types. Available types are: SmartCard, KeyToken, VirtualToken, MobileToken, FileToken and NonToken.

TokenSubType

Returns a list of subordinated token types. Available types are: Access, eToken, PKCS12, SoftToken, TPM and YubiKey.

TokenUsage

Returns a list of token usage types. Available types are: Standard and Limited.

UnlockTokenType

Returns a list of unlock token types. Available types are: UnlockToken, Display and ChallengeResponseDisplay.

UserAlias

This call requires Id argument. Returns a list of available alias accounts of a user.

UserAliasTaskType

Returns a list of task types dedicated for user alias items (e.g. CreateUserAlias, AssignUserAlias and DeleteUserAliasAssignment).

UserGroup

Returns a list of available user groups.

UserGroupAssigned

This call requires Id argument. Returns a list of available user groups assigned of a user.

UserImageType

Returns a list of image types for a user. Available types are: PersonPhoto and PersonSignature.

UserRoleGroup

This call requires Id argument. Returns a list of available user groups, including roles, of a user.

UserType

Returns a list of user types. Available types are: Person and Service.