How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PPL Documents API

Manages document files and document metadata across the Placement hierarchy, including the Market Reform Contract (MRC) itself and its supporting documents, with versioning, content retrieval, download and a separate secured content and download path. This is the contract-issuance surface. OpenAPI 3.0.1, 8 paths and 11 operations.

PPL Documents API is one of 5 APIs that PPL publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents, Market Reform Contract, Versioning, and Issuance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 8 paths, organized into 3 resource areas, and defines 19 schemas. It is described by OpenAPI 3.0.1, at version 1.

Requests are made against a single base URL, https://sand-api.londonmarketgroup.co.uk/ppl/nextgen/documents.

11 operations 8 paths 19 schemas 1 DELETE6 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1
Base URL
https://api.londonmarketgroup.co.uk/ppl/nextgen/documents/v1
Resource Areas
3

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 3 POST, 1 PUT. They span 3 resource areas: health, version, document. Each is listed below with its method, path, parameters, and response codes.

health 1
GET
/health
Checks the health of this Document Resource API.
Health → 200
version 1
GET
/version
Checks the version of this Document Resource API.
Version → 200
document 9
GET
/documents
Returns a list of all Document records associated within a specified Placement structure, based upon various query parameters. Pagination functionality is supported on this operation.
Document_GetAll_v1 19 params → 200400401404414429500
POST
/documents
Creates a Document record, representing either the Market Reform Contract (MRC) or another type of supporting document. The request contains the document attributes as well as the electronic file whi…
Document_Post_v1 2 params body → 200400401404414429500
GET
/documents/versions/{documentVersionId}
Returns a single Document record. This record will contain the document attributes of the document, but does not provide the electronic file.
Document_GetById_v1 3 params → 200400401404414429500
PUT
/documents/versions/{documentVersionId}
Updates the data attributes of a Document record. This operation will not replace the electronic file.
Document_Put_v1 4 params body → 200400401404414429500
DELETE
/documents/versions/{documentVersionId}
Deletes a Document record, where the record is in a state that enables its deletion.
Document_Delete_v1 3 params → 200400401404414429500
GET
/documents/versions/{documentVersionId}/content
Returns the electronic file that is represented by the Document record. This is the subsequent end point that is called following an asynchronous response that the electronic file is ready to be down…
Document_GetContent_v1 4 params → 200400401404414429500
POST
/documents/versions/{documentVersionId}/download
Initiates the asynchronous operation to download the electronic file of this document.
Document_PostDownload_v1 3 params body → 200400401404414429500
GET
/documents/versions/{documentVersionId}/security/content
Returns the electronic file that represents the Market Reform Contract with its underwriting security page(s) and settlement information. This is the subsequent end point that is called following an…
Document_GetSecurityContent_v1 4 params → 200400401404414429500
POST
/documents/versions/{documentVersionId}/security/download
Initiates the asynchronous operation to download the Market Reform Contract with its underwriting security page(s) and settlement information.
Document_PostSecurityDownload_v1 3 params body → 200400401404414429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are document_delete_response (17 properties), document_get (16 properties), document_post_response (10 properties), document_post_FileString (7 properties). Each schema is shown below with its type and property counts.

health
object
Health endpoint payload
1 property
version
object
Version endpoint payload
2 properties
broker_team
object
The team information of the Broker Team responsible for the node.
2 properties 2 required
context_document
object
Contextual information about where this Document sits within the Placement structure hierarchy. Document records can exist at Placement, Programme, Contract, S…
2 properties 2 required
document_delete_response
object
Document for Delete Output
17 properties 17 required
document_get
object
Document for (generic) Gets
16 properties 16 required
document_post_FileString
object
Document structure for creates
7 properties 6 required
document_post_response
object
Document for Post Output
10 properties 9 required
document_post_download
Dummy payload for LIMOSS Consumption
document_post_securitydownload
object
Document input structure for post security download
5 properties 5 required
document_post_securitydownload_output
object
Document output structure for post security download
6 properties 6 required
document_put
object
Document structure for updates
5 properties 5 required
metadata
object
A collection of data items to support the creation and update of record entities.
6 properties 6 required
metadata_user
object
The User information of the Metadata User.
3 properties 1 required
notification
object
The Notification information relating to the Document.
4 properties 4 required
response_documents_getall
object
5 properties
team_user
object
The User information of the User.
3 properties 1 required
error
object
4 properties
error_document
object
The error document.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ppl-london-market-documents.json Raw ↑

Other APIs PPL publishes across the network.

PPL Placements API
PPL Submissions API
PPL Organisations API
PPL Events API
Where this information came from

This is an independent, third-party profile of PPL Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.