Problem Types
This page describes the problem types you can get from CPPA.
Problemkode | Title | Detail | Status Code |
---|---|---|---|
GF-1 |
Not authorized. | Caller is authenticated, but does not have sufficient permissions. HelseId personal users must be signed in with security level 4, and have permissions to change the entity in AR (AR Admin). HelseId machine users must belong to the organization owning the entity in AR. |
403 |
GF-2 |
Invalid HerId. | HerId dont exist or if its not of type service og person. | 400 |
GF-3 |
Unknown UUID in process definition. | The UUID of the process is unknown. | 400 |
GF-4 |
Unknown version in process definition. The given UUID has no such version. | The version of the process is unknown. | 400 |
GF-5 |
Unknown role in process definition. The given UUID and version does not have such a role. | The given UUID and version does not have such a role. | 400 |
GF-6 |
Missing enterprise certificate information on communication party. Please update certificate information. | Creating of CPP failed because it failed to get a certificate from AR. | 400 |
GF-7 |
Missing delivery channel details on communication party. | This often occur when creating a CPP and the herId are missing a AMQP address. | 400 |
GF-8 |
HerId(s) do not have a profile. | Create a profile for the communication party by adding supported processes to it (e.g. POST /Profiles//Processes) | 404 |
GF-9 |
CpaID does not exist. | The requested CPA-Id dont exist. | 404 |
GF-10 |
Could not create a collaboration protocol agreement: No common processes exist. | The provided communication parties have no processes in common where Uuid and Version match, but Role is different. | 400 |
GF-11 |
Invalid certificate chain for certificate in profile. | One of the certificates in the profile of the given communication party could not be validated. Please update the relevant certificate on the affected communication party. See the chainElements property for further information about the relevant certificate(s). | 400 |
GF-12 |
Invalid policy identifier for certificate in profile. | One of the certificates in the profile does not have a valid Policy Identifier, and is not valid for use with Cppa. Please update the relevant certificate on the affected communication party. | 400 |
GF-13 |
JSON syntax error. | One or more validation errors occured. See the errors property for details. | 400 |
GF-14 |
Untrusted root certificate on certificate in profile. | One of the certificates on the given communication party are issued by a certificate authority that is not trusted by this application. Please update the relevant certificate on the affected communication party. | 400 |
GF-15 |
The given process does not exist on the profile. | When deleting/patching with /Profiles//Processes/// and the process dont exist on profile. | 400 |
GF-16 |
Found no matching agreements for the given communication party. | GET /AgreementSummaries/ and the communicationParty dont have any agreements. | 404 |
GF-17 |
Not authenticated. | Caller is not signed in. | 401 |
GF-21 |
Unsupported value in Accept header. | If not xml or json is specified in the accept header. See below for which endpoints this applies to. | 400 |
GF-24 |
The Agreement can't be created because the HerIds provided are identical. | If you try to get an agreement between two identical herId. | 400 |
GF-25 |
CommunicationParty is expired. | The CommunicationParty is expired, all profiles are removed. Please update the valid timeperiod to activate it again. | 404 |
GET /Profiles/herId
see for documentation
- Response code
200
:- Ok.
- Response code
400
:- Request is invalid. Problem type GF-21. If not xml or json is specified in the accept header.
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
: Not Found- Problem type GF-8. If the herId dont have a profile or the existing profile is expired.
GET /Profiles/herId
/History see to for documentation
- Response code
200
:- Ok.
- Response code
401
:- Unauthorized. Problem type Gf17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
: Not Found
GET /Profiles/herId
/Processes see to for documentation
- Response code
200
:- Ok.
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
:- Not Found. Problem type GF-8. If the herId dont have a profile or the existing profile is expired.
POST /Profiles/herId
/Processes see to for documentation
- Response code
204
:- No Content. The request was successfully processed.
- Response code
400
:- Request is invalid. Possible problem types include:
- GF-2 - If the HerId dont exist or if its not of type service og person.
- GF-3 - The UUID of the process definition is unknown.
- GF-4 - If the process with the given UUID has no such version.
- GF-5 - The given UUID and version does not have such a role.
- GF-6 - Missing enterprise certificate information on communication party.
- GF-7 - If the communicationParty missing delivery channel details on communication party.
- Request is invalid. Possible problem types include:
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-25. If the communicationParty of the CPP you are appending a new processes to is expired.
PATCH /Profiles/herId
/Processes/uuid
/version
/role
see for documentation
- Response code
204
:- No Content. The request was successfully processed.
- Response code
400
:- Request is invalid. Possible problem types include:
- GF-2 - If the HerId dont exist or if its not of type service og person.
- GF-3 - The UUID of the process definition is unknown.
- GF-4 - If the process with the given UUID has no such version.
- GF-5 - The given UUID and version does not have such a role.
- GF-6 - Missing enterprise certificate information on communication party.
- GF-7 - If the communicationParty missing delivery channel details on communication party.
- GF-15 - If the given process does not exist on the profile.
- Request is invalid. Possible problem types include:
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Possible problem types include:
- GF-8. If the herid dont have a CPP. Or if the HerId has a CPP is not valid.
- GF-25. If the HerId has a profile, but its deactivated.
- Not Found. Possible problem types include:
PUT /Profiles/herId
/Processes/ see for documentation
- Response code
204
:- No Content. The request was successfully processed.
- Response code
400
:- Request is invalid. Possible problem types include:
- GF-2 - If the HerId dont exist or if its not of type service og person.
- GF-3 - The UUID of the process definition is unknown.
- GF-4 - If the process with the given UUID has no such version.
- GF-5 - The given UUID and version does not have such a role.
- GF-6 - Missing enterprise certificate information on communication party.
- GF-7 - If the communicationParty missing delivery channel details on communication party.
- Request is invalid. Possible problem types include:
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-25 - If the communicationParty is not valid.
DELETE /Profiles/herId
/Processes/uuid
/version
/role
see for documentation
- Response code
204
:- No Content. The request was successfully processed.
- Response code
400
:- Request is invalid. Possible problem types include:
- GF-2 - If the HerId dont exist or if its not of type service og person.
- GF-3 - The UUID of the process definition is unknown.
- GF-4 - If the process with the given UUID has no such version.
- GF-5 - The given UUID and version does not have such a role.
- GF-6 - Missing enterprise certificate information on communication party.
- GF-7 - If the communicationParty missing delivery channel details on communication party.
- GF-15 - If the given process does not exist on the profile
- Request is invalid. Possible problem types include:
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Possible problem types include:
- GF-8. If the herId dont have a profile or the existing profile is expired.
- GF-25 - If the HerId has a profile, but it is deactivated.
- Not Found. Possible problem types include:
GET /Agreements/cpaId
see for documentation
- Response code
200
:- Ok.
- Response code
400
:- Request is invalid. Problem type GF-21. If not xml or json is specified in the accept header.
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-9. If no CollaborationProtocolAgreements have an Id matching
GET /Agreements/HerIds/herIdA
/herIdB
see for documentation
- Response code
200
:- Ok.
- Response code
400
:- Request is invalid. Possible problem types include:
- GF-10 - If the parties have no compatible CollaborationProtocolProfiles.
- GF-11 - If invalid certificate chain for certificate in profile.
- GF-12 - If there is an invalid policy identifier for a certificate in one of the profiles.
- GF-14 - Untrusted root certificate on certificate in profile.
- GF-21 - If not xml or json is specified in the accept header.
- GF-24 - Because the provided HerIds are identical.
- Request is invalid. Possible problem types include:
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-8. If a party does not have a CollaborationProtocolProfile.
DELETE /Agreements/cpaId
see for documentation
- Response code
204
:- No Content. The request was successfully processed.
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-9. If no CollaborationProtocolAgreements have an Id matching.
GET /AgreementSummaries/herId
see for documentation
- Response code
200
:- Ok.
- Response code
400
:- Request is invalid. Problem type GF-2. If the HerID is unknown.
- Response code
401
:- Unauthorized. Problem type GF-17. The caller is not authenticated.
- Response code
403
:- Forbidden. Problem type GF-1. If caller is authenticated, but does not have sufficient permission.
- Response code
404
- Not Found. Problem type GF-16. If there are no matching agreements