Retrieves the collection of ITOrderResponse resources.
ITOrderResponse collection
{- "hydra:member": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "initial",
- "orderStatus": "revised",
- "documentReference": { }
}, - "responses": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": { }
}
]
}
}
], - "hydra:totalItems": 0,
- "hydra:view": {
- "@id": "/entity/1",
- "@type": "string",
- "hydra:first": "/entity/1",
- "hydra:last": "/entity/1",
- "hydra:previous": "/entity/1",
- "hydra:next": "/entity/1"
}, - "hydra:search": {
- "@type": "string",
- "hydra:template": "string",
- "hydra:variableRepresentation": "string",
- "hydra:mapping": [
- {
- "@type": "string",
- "variable": "string",
- "property": "string",
- "required": true
}
]
}
}
Mark the order response as downloaded. This is useful to keep track of the document that have been received by the user.
ITOrderResponse resource created
Invalid input
Unprocessable entity
{- "downloaded": true,
- "uuids": [
- "string"
]
}
null
Import a received NSO order response in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type
header (application/xml
or application/json
).
The new ITOrderResponse resource
ITOrderResponse resource created
Invalid input
Unprocessable entity
null
{- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": {
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "initial",
- "orderStatus": "revised",
- "documentReference": { }
}, - "responses": [
- {
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": { }
}
]
}
}
Send a NSO order response in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type
header (application/xml
or application/json
).
Optionally you can send the X-Validation-Rule: {validation-rule-code}
where {validation-rule-code}
is one of the available validation rules you can use.
You can retrieve a list of the available validation rules using the API GET /validation-rules
.
By default the validation rule is autodetected using the latest rule available for the given document.
The new ITOrderResponse resource
ITOrderResponse resource created
Invalid input
Unprocessable entity
null
{- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": {
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "initial",
- "orderStatus": "revised",
- "documentReference": { }
}, - "responses": [
- {
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": { }
}
]
}
}
Retrieves a ITOrderResponse resource.
ITOrderResponse resource
Resource not found
{- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "initial",
- "orderStatus": "revised",
- "documentReference": { }
}, - "responses": [
- {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "direction": "outgoing",
- "format": "UBL 2.1 XML",
- "number": "string",
- "date": "string",
- "sender": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "recipient": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "name": "string",
- "identifier": "string"
}, - "createdAt": "string",
- "downloaded": true,
- "peppolMessage": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "uuid": "string",
- "createdAt": "string",
- "requestSentAt": "string",
- "responseReceivedAt": "string",
- "success": true,
- "errorCode": "string"
}, - "processType": "order only",
- "processInformation": {
- "@context": "string",
- "@id": "string",
- "@type": "string",
- "documentType": "order received",
- "responseCode": "AB",
- "orderResponseStatus": "accepted"
}, - "order": { }
}
]
}
}
If you specify header Accept equal to 'application/pdf' or 'text/html' you will receive a 302 redirect response with the Location header pointing to the downloadable file. Additionally you get the URL to the downloaded file in the JSON response body.
If you specify header Accept equal to 'application/json' you will receive 200 status code and the JSON response containing the URL to follow manually.
You can avoid the 302 redirect response by sending header X-WithRedirect: false
ITOrderResponse resource
Resource not found