Response Schema
Unlock seamless integration and rapid development with the Nodinite LDAP Web API response schema. This schema ensures you receive predictable, developer-friendly data in both XML and JSON formats.
✅ Rely on a unified schema for both XML and JSON responses
✅ Integrate easily with BizTalk, custom code, and any platform
✅ Accelerate development with clear, pre-defined structures
✅ Avoid surprises—always know what data to expect
The Nodinite LDAP products always return data according to a pre-defined schema. You receive the schema in XSD format for XML messages, and the JSON structure follows the same definition. As a developer, you can easily use and validate these responses in your solutions.
| File | IS.BizTalk.Adapters.LDAP.Response_v1.0.xsd |
| Target Namespace | http://integrationsoftware.se/BizTalk/Adapters/LDAP/Response/1.0 |
| Root Node | LDAP |
| BizTalk Message Type | http://integrationsoftware.se/BizTalk/Adapters/LDAP/Response/1.0#LDAP |
You do not need to install this schema in your BizTalk environment unless you create your own maps (.BTM files) or use custom-built pipelines/components that require it.
The root record is named LDAP, matching the Request schema structure. The Response message mirrors the Request structure but includes results, status information, and any data returned from operations.
Batch
Each batch in the request is represented by a corresponding batch in the response message.
The index attribute represents the numeric index position of the returned batch, allowing you to correlate request batches with their responses.
Entities
Each entity provided in the request batch is represented by a corresponding entity record in the response message.
The name attribute identifies the type of entity (User, Group, OrganizationalUnit, Schema, or AD).
There can be any number of entity records in the response message, depending on the operations performed in the request.
With
The With record from the request (if provided) is copied to the corresponding With record in the response message. This helps you correlate the search criteria used with the results returned.
Operation
The Operation records are repeated in the Operations collection for each operation requested in the batch.
The index attribute provides the position of the operation in the sequence.
The name attribute identifies the operation performed (e.g., Create, Update, Delete, Get).
Operation Status Information
Each operation includes additional information:
ReturnStatus
The ReturnStatus element displays the status of the operation with one of these values:
- NotExecuted - The operation was not performed (typically due to a previous error)
- Success - The operation completed successfully
- Warning - The operation completed but with warnings
- Failed - The operation failed
ExecutionDuration
The ExecutionDuration element displays the time in milliseconds the operation took to execute.
RecordsFoundCount
The RecordsFoundCount element shows the number of records found (and presented in the SearchResult record) from the search query provided by the With part of the Request message.
Error and Warning Information
When operations fail or encounter issues, additional elements are included:
ExceptionMessage
The ExceptionMessage element includes a short description of the exception (e.g., ex.Message).
ExceptionMessageExtended
The ExceptionMessageExtended element contains detailed information about the exception (e.g., ex.ToString()), including stack traces for debugging.
Warnings
The Warnings element contains information when an operation succeeded but the adapter signaled some anomaly or issue that should be reviewed.
SearchResult
All objects found by the query are listed in the SearchResult record. The properties returned may be filtered based on the returnProperties attribute in the request (see Request Schema - returnProperties).
If the selected object contains lists of child items, these are listed in the DirectoryEntries child record and may be repeated for different types of child items.
SearchResult Attributes
schemaClassName
The schemaClassName attribute provides information about the type of object selected (e.g., user, group, organizationalUnit).
index
The index attribute represents the position of the record in the result set.
name
The name attribute provides the name given to the object in the LDAP directory.
Properties Collection
Each property of the object is listed in a name/value properties collection record. The property names correspond to LDAP attribute names, and values contain the data stored in those attributes.
OperationResult
If the operation performed any action (Create, Update, Delete), the affected record is listed in the OperationResult record.
The OperationResult structure is similar to SearchResult, showing the state of the object after the operation completed. This provides traceability and allows you to verify that changes were applied correctly.
Next Step
- Review the Request Schema for message structure
- Explore User Management for practical examples
- Learn about Logging for traceability