Retrieves the collection of LegalEntity resources.
LegalEntity collection
Forbidden
{- "hydra:member": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "registeredName": "string",
- "country": "string",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
], - "smpEnabled": true,
- "createdAt": "string",
- "updatedAt": "string"
}
], - "hydra:totalItems": 0,
- "hydra:view": {
- "@id": "string",
- "type": "string",
- "hydra:first": "string",
- "hydra:last": "string",
- "hydra:previous": "string",
- "hydra:next": "string"
}, - "hydra:search": {
- "@type": "string",
- "hydra:template": "string",
- "hydra:variableRepresentation": "string",
- "hydra:mapping": [
- {
- "@type": "string",
- "variable": "string",
- "property": "string",
- "required": true
}
]
}
}
Creates a LegalEntity resource.
The new LegalEntity resource
LegalEntity resource created
Invalid input
Forbidden
An error occurred
{- "registeredName": "string",
- "country": "st",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
]
}
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "registeredName": "string",
- "country": "string",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
], - "smpEnabled": true,
- "createdAt": "string",
- "updatedAt": "string"
}
Retrieves a LegalEntity resource.
LegalEntity resource
Forbidden
Not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "registeredName": "string",
- "country": "string",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
], - "smpEnabled": true,
- "createdAt": "string",
- "updatedAt": "string"
}
Replaces the LegalEntity resource.
The updated LegalEntity resource
LegalEntity resource updated
Invalid input
Forbidden
Not found
An error occurred
{- "registeredName": "string",
- "country": "st",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
]
}
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "registeredName": "string",
- "country": "string",
- "address": "string",
- "city": "string",
- "stateOrProvince": "string",
- "zipCode": "string",
- "identifierScheme": "iso6523-actorid-upis",
- "identifierValue": "string",
- "receivedDocumentNotificationEmails": [
- "string"
], - "smpEnabled": true,
- "createdAt": "string",
- "updatedAt": "string"
}
Removes the LegalEntity resource.
LegalEntity resource deleted
Forbidden
Not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "title": "string",
- "detail": "string",
- "status": 404,
- "instance": "string",
- "type": "string",
- "description": "string"
}
Read the SMP records for the LegalEntity resource
LegalEntity resource
Forbidden
Not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "enabled": true,
- "capabilities": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentTypeScheme": "string",
- "documentType": "string",
- "processScheme": "string",
- "process": "string"
}
]
}
Manage the SMP records for the LegalEntity resource
The updated LegalEntity resource
LegalEntity resource updated
Invalid input
Forbidden
Not found
An error occurred
{- "enabled": true,
- "capabilities": [
- {
- "documentTypeScheme": "busdox-docid-qns",
- "documentType": "string",
- "processScheme": "cenbii-procid-ubl",
- "process": "string"
}
]
}
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "enabled": true,
- "capabilities": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentTypeScheme": "string",
- "documentType": "string",
- "processScheme": "string",
- "process": "string"
}
]
}
Read the Transfer Bridge options for the LegalEntity resource
LegalEntity resource
Forbidden
Not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "peppolSdiEnabled": true
}
Manage the Transfer Bridge options for the LegalEntity resource
LegalEntity resource updated
Invalid input
Forbidden
Not found
An error occurred
{- "peppolSdiEnabled": true
}
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "peppolSdiEnabled": true
}