GetObject

This call will load an entity object of the system. The response will contain different kind of entity object depending on type in the request (e.g. User, Token etc. etc.). This call must be encrypted.

Parameters

Input-SessionId

The current session id as base64-string. This type is mandatory.

Input-Type

The type of the entity object. This must be a string value. This type is mandatory. Available types are:

  • ApplicationInfo

  • User

  • Token

  • EndEntity

  • Report

  • TokenManufacturer

  • TokenManufacturerArticle

  • TokenProfile

See GetObject object types for detailed documentation of all available object types and their fields.

Input-Id

The id of the entity object. This must be a numeric value. This type is mandatory.

Input-Count

The current call-count of the session. This must be a numeric value. This type is mandatory.

SOAP implementation

Content type

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

Header

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

Request
<?xml version="1.0" encoding="utf-8"?>

<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>
        <GetObject xmlns="http://www.pointsharp.com/netid/server/portal">
            <Info>
                <SessionId></SessionId>
                <Type>User</Type>
                <Id>5</Id>
                <Count>2</Count>
            </Info>
        </GetObject>
    </s:Body>
</s:Envelope>
Response
<?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">
        <GetObjectResponse xmlns="http://www.pointsharp.com/netid/server/portal">
            <GetObjectResult>
                <User>
                    <Id>5</Id>
                    <Name>John Doe</Name>
                    <EmploymentType>PermanentContract</EmploymentType>
                    <ImageId>19</ImageId>
                    <SignatureImageId>20</SignatureImageId>
                    <SerialNumber>0123456789</SerialNumber>
                    <Phone>070000000</Phone>
                    <Email>john.doe@contoso.com</Email>
                    <OrganizationName>Contoso Ltd</OrganizationName>
                </User>
                <Status>
                    <Code>Success</Code>
                    <Description>Success</Description>
                </Status>
            </GetObjectResult>
        </GetObjectResponse>
    </s:Body>
</s:Envelope>

REST implementation

Content type

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

Method

POST

URI

/api/object/get

Request
{
    "SessionId": "",
    "Type": "User",
    "Id": "5",
    "Count": "2"
}
Response
{
    "User": {
        "Id": "5",
        "Name": "John Doe",
        "EmploymentType": "PermanentContract",
        "ImageId": "19",
        "SignatureImageId": "20",
        "SerialNumber": "0123456789",
        "Phone": "070000000",
        "Email": "john.doe@contoso.com",
        "OrganizationName": "Contoso Ltd"
    },
    "Status": {
        "Code": "Success",
        "Description": "Success"
    }
}

Output

The response will contain the entire object typed in the request. See GetObject object types for detailed field documentation for each object type.