GetData

This method loads attributes and data from objects in the system.

Parameters

SessionId

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

Id

The identifier of the requested object. This type is optional.

Type

The type of data. The syntax must be encoded as \{INSTANCE.OBJECT.ATTRIBUTE} if set as a single value. This type is mandatory.

Count

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

Additional parameters

It’s possible to add additional parameters against the type.

Abbrevation

This will abbreviate the data.

Example: \{internal.user.name(abbrevation=4)}

This example will return the name of a user (e.g. John Doe) which will result the value abbrevated to four characters (e.g. John).

Normalize

This will normalize the data with binary representation is in unicode. Example: \{internal.user.name(normalize=true)}

This example will return the name of a user (e.g. Jonas Söderberg) which will result the value normalized (e.g. Jonas Soderberg).

CertificateHeaders

This will set headers when loading certificates.

Example: \{internal.certificate.data(certificateheaders=true)}

This example will return the certificate PEM-encoded (e.g BEGIN CERTIFICATE-----MII… -----END CERTIFICATE ).

Base64

This will convert the data as base64 string.

Example: \{internal.user.name(base64=true)}

This example will return the name of a user (e.g. Jonas Söderberg) which will result the value as base64 encoded (e.g. Sm9uYXMgU8O2ZGVyYmVyZw==).

LowerCase

This will encode the data to lower case letters. Example: \{internal.user.name(lowercase=true)}

This example will return the name of a user (e.g. John Doe) which will result the value in lower case (e.g. john doe).

UpperCase

This will encode the data to upper case letters. Example: \{internal.user.name(uppercase=true)}

This example will return the name of a user (e.g. John Doe) which will result the value in upper case (e.g. JOHN DOE).

SOAP implementation

Content type

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

Header

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

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>
    <GetData xmlns="http://www.pointsharp.com/netid/server/portal">
      <Info>
        <SessionId></SessionId>
        <Id>3</Id>
        <Type>{internal.user.name}</Type>
        <Count>1</Count>
      </Info>
    </GetData>
  </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">
    <GetDataResponse xmlns="http://www.pointsharp.com/netid/server/portal">
      <GetDataResult>
        <DataList>
          <DataObj>
            <Value>John Doe</Value>
            <MimeType>text/plain</MimeType>
          </DataObj>
        </DataList>
        <Status>
          <Code>Success</Code>
          <Description>Success</Description>
        </Status>
      </GetDataResult>
    </GetDataResponse>
  </s:Body>
</s:Envelope>

REST implementation

Content type

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

Method

POST

URI

/api/data/get

Request
{
  "SessionId": "",
  "Id": "3",
  "Type": "{internal.user.name}",
  "Count": "2"
}
Response
{
  "DataList": [
    {
      "Value": "John Doe",
      "MimeType": "text/plain"
    }
  ],
  "Status": {
    "Code": "Success",
    "Description": "Success"
  }
}

Data types

The GetData method supports a wide variety of data types organized into different categories. For detailed information about each data type, see the following reference pages: