{"note":"OpenAPI conversion -- returning structured metadata","name":"id4i-de","description":"ID4i API","version":"1.0.2","base_url":"https://backend.id4i.de/","endpoints":107,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ID4i API\n@base https://backend.id4i.de/\n@version 1.0.2\n@auth ApiKey Authorization in header\n@endpoints 107\n@hint download_for_search\n@toc account(5), api(99), go(1), login(1), whois(1)\n\n@group account\n@endpoint POST /account/password\n@desc Request password reset\n@required {resetRequest: map # Contains the required information to request a new password.}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /account/password\n@desc Verify password reset\n@required {verificationRequest: map # Contains the new password and the verification token to set the new password.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /account/registration\n@desc Register user\n@required {userRegistration: map # The user information about the new created user.}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /account/registration\n@desc Complete registration\n@required {completeRegistration: map # Contains the verification token, the username and the initial password.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /account/verification\n@desc Verify registration\n@required {token: map # The token for user verification.}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endgroup\n\n@group api\n@endpoint GET /api/v1/apikeys\n@desc Find API key by organization\n@optional {organizationId: any # The namespace of the organization to search in., offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/apikeys\n@desc Create API key\n@required {creationRequest: map # API key to be created.}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/apikeys/privileges\n@desc List all privileges\n@optional {id4nConcerning: any # id4nConcerning, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/apikeys/{key}\n@desc Show API key\n@required {key: any # The API key to show.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/apikeys/{key}\n@desc Update API keys\n@required {key: any # The API key to be updated., apiKeyChange: map # The new values to apply.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/apikeys/{key}\n@desc Delete API key\n@required {key: any # The API key to delete.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/apikeys/{key}/privileges\n@desc List privileges\n@required {key: any # key}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/apikeys/{key}/privileges\n@desc Add privilege\n@required {key: any # key, addApiKeyPrivilegeRequest: map # addApiKeyPrivilegeRequest}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/apikeys/{key}/privileges\n@desc Remove privilege\n@required {key: any # key, removeApiKeyPrivilegeRequest: map # removeApiKeyPrivilegeRequest}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/apikeys/{key}/privileges/{privilege}/id4ns\n@desc ID4ns of a privilege\n@required {key: any # key, privilege: any # privilege}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/apikeys/{key}/privileges/{privilege}/id4ns\n@desc Add ID4ns of a privilege\n@required {key: any # key, privilege: any # privilege, id4ns: map # id4ns}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/apikeys/{key}/privileges/{privilege}/id4ns\n@desc Remove id4ns of a privilege\n@required {key: any # key, privilege: any # privilege, id4ns: map # id4ns}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/billing/{organizationId}\n@desc Get billing amount of services for a given organization\n@required {organizationId: any # The organization to compute the billing information for}\n@optional {fromDate: any # Billing start date, toDate: any # Billing end date}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/billing/{organizationId}/positions\n@desc Get billing positions for a given organization\n@required {organizationId: any # The organization to compute the billing information for}\n@optional {fromDate: any # Billing start date, toDate: any # Billing end date}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/changelog/organization/{organizationId}/\n@desc List change log entries of an organization\n@required {organizationId: any # The namespace identifying the organization whose change log entries are to be listed}\n@optional {messageMimeType: any # The Mime-type for the message format that should be returned. e.g. 'text/plain' or 'text/mustache', fromDate: any # From date time as UTC Date-Time format, toDate: any # To date time as UTC Date-Time format, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/collections\n@desc Create collection\n@required {createInfo: map # createInfo}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/collections/{id4n}\n@desc Find collection\n@required {id4n: any # id4n}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/collections/{id4n}\n@desc Delete collection\n@required {id4n: any # id4n}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/collections/{id4n}\n@desc Update collection\n@required {id4n: any # id4n, request: map # request}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /api/v1/collections/{id4n}/elements\n@desc List contents of the collection\n@required {id4n: any # id4n}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements, organizationId: any # The organization namespace.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/collections/{id4n}/elements\n@desc Add elements to collection\n@required {id4n: any # id4n, listOfGuids: map # listOfGuids}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/collections/{id4n}/elements\n@desc Remove elements from collection\n@required {id4n: any # id4n, listOfGuids: map # listOfGuids}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/countries\n@desc List countries\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/documents/{id4n}\n@desc List documents\n@required {id4n: any # id4n}\n@optional {owner: any # Filter by owner organization, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/documents/{id4n}/{organizationId}\n@desc List organization specific documents\n@required {organizationId: any # organizationId, id4n: any # id4n}\n@optional {owner: any # Filter by owner organization, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/documents/{id4n}/{organizationId}\n@desc Create an document for an id4n\n@required {organizationId: any # organizationId, id4n: any # id4n, content: any # content}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/documents/{id4n}/{organizationId}\n@desc Put an document for an id4n\n@required {organizationId: any # organizationId, id4n: any # id4n, content: any # content}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/documents/{id4n}/{organizationId}/{fileName}\n@desc Read document contents\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/documents/{id4n}/{organizationId}/{fileName}\n@desc Delete a document\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata\n@desc Retrieve a document (meta-data only, no content)\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata\n@desc Update a document\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName, document: map # document}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /api/v1/guids\n@desc Create GUID(s)\n@required {createGUIDInfo: map # GUID creation model}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/guids/withoutCollection\n@desc Retrieve GUIDs not in any collection\n@required {organizationId: any # The namespace of the organization to search GUIDs for}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/guids/{id4n}\n@desc Retrieve GUID information\n@required {id4n: any # The GUID number}\n@optional {organizationId: any # The organization namespace to resolve.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/guids/{id4n}\n@desc Change GUID information.\n@required {id4n: any # The GUID number, request: map # request}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /api/v1/history/{id4n}\n@desc List history\n@required {id4n: any # GUID to retrieve the history for}\n@optional {includePrivate: any # Also return private history entries, organization: any # Show only entries created by one of the given organizations. This parameter can be used multiple times., type: any # Show only entries matching one of the given history item types. This parameter can be used multiple times., qualifier: any # Show only entries matching one of the given history item qualifiers (additional property de.id4i.history.item.qualifier). This parameter can be used multiple times., fromDate: any # From date time as UTC Date-Time format, toDate: any # To date time as UTC Date-Time format, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/history/{id4n}\n@desc Add history item\n@required {id4n: any # GUID to retrieve the history for, historyItem: map # The history item to publish}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/history/{id4n}/{organizationId}\n@desc DEPRECATED - List history\n@required {id4n: any # GUID to retrieve the history for, organizationId: any # organizationId}\n@optional {includePrivate: any # Also return private history entries, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/history/{id4n}/{organizationId}/{sequenceId}\n@desc Get history item\n@required {id4n: any # GUID to retrieve the history for, organizationId: any # organizationId, sequenceId: any # sequenceId}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/history/{id4n}/{organizationId}/{sequenceId}\n@desc Update history item\n@required {id4n: any # GUID to retrieve the history for, organizationId: any # organizationId, sequenceId: any # sequenceId, update: map # update}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint PUT /api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility\n@desc Set history item visibility\n@required {id4n: any # GUID to retrieve the history for, organizationId: any # organizationId, sequenceId: any # sequenceId, visibility: map # History item visibility restrictions}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/id4ns/{id4n}\n@desc Retrieve ID4n information\n@required {id4n: any # The ID to resolve to}\n@optional {organizationId: any # The organization namespace to resolve.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/id4ns/{id4n}/alias\n@desc Get all aliases for the given GUID or Collection.\n@required {id4n: any # The GUID or Collection to operate on}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/id4ns/{id4n}/alias/{aliasType}\n@desc Add alias for GUID or Collection\n@required {id4n: any # The GUID or Collection to operate on, aliasType: any # Alias type, see the corresponding API model, alias: map # The alias to add or update}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/id4ns/{id4n}/alias/{aliasType}\n@desc Remove aliases from GUID or Collection\n@required {id4n: any # The GUID or Collection to operate on, aliasType: any # Alias type, see the corresponding API model}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/id4ns/{id4n}/collections\n@desc Retrieve collections of an ID\n@required {id4n: any # The ID which the collections should contain}\n@optional {organizationId: any # The organization holding the collections., offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/id4ns/{id4n}/properties\n@desc Retrieve ID4n properties\n@required {id4n: any # The id4n}\n@optional {organizationId: any # The organization namespace.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/id4ns/{id4n}/properties\n@desc Delete ID4n properties\n@required {id4n: any # The id4n, organizationId: any # The organization namespace to work on while deleting the properties., properties: [str] # A set of property keys to delete.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/id4ns/{id4n}/properties\n@desc Patch ID4n properties\n@required {id4n: any # The id4n, organizationId: any # The organization namespace to work on while patching the properties., properties: map # The properties to update.}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /api/v1/import/gs1\n@desc Import GS1/MAPP codes\n@required {importGS1CodesRequest: map # The information how the MAPP codes should be imported and the list of MAPP codes}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/info\n@desc Retrieve version information about ID4i\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/microstorage/{id4n}/{organization}\n@desc Read data from microstorage\n@required {organization: any # organization, id4n: any # id4n}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/microstorage/{id4n}/{organization}\n@desc Write data to microstorage\n@required {organization: any # organization, id4n: any # id4n}\n@optional {Content-Type: any # Content-Type, Content-Length: any # Content-Length, body: str(byte) # body}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/multiple/id4ns/properties\n@desc Get multiple ID4n properties\n@required {id4ns: any # The list of ID4ns to resolve.}\n@optional {organizationId: any # The organization namespace.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/organizations\n@desc Create organization\n@required {organization: map # Organization to be created}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}\n@desc Find organization by id/namespace\n@required {organizationId: any # The namespace of the organization to be retrieved.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/organizations/{organizationId}\n@desc Update organization\n@required {organizationId: any # The namespace of the organization to be updated., organizationUpdate: map # Updated organization object}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/organizations/{organizationId}\n@desc Delete organization\n@required {organizationId: any # The namespace of the organization to be deleted.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/addresses/billing\n@desc Retrieve billing address\n@required {organizationId: any # organizationId}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/organizations/{organizationId}/addresses/billing\n@desc Store billing address\n@required {organizationId: any # organizationId, addressResource: map # addressResource}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/organizations/{organizationId}/addresses/billing\n@desc Remove billing address\n@required {organizationId: any # organizationId}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/addresses/default\n@desc Retrieve address\n@required {organizationId: any # organizationId}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/organizations/{organizationId}/addresses/default\n@desc Store address\n@required {organizationId: any # organizationId, addressResource: map # addressResource}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/collections\n@desc Get collections of organization\n@required {organizationId: any # The namespace of the organization}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements, type: any # Filter by this type, label: any # Filter by this label, labelPrefix: any # Filter by this label prefix, property: any # List of i4dn property filter. e.g. \"com.myorga.state:IN:waiting|processing\" or \"com.myorga.orderId:EQ:SAP001\"}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/organizations/{organizationId}/logo\n@desc Update organization logo\n@required {organizationId: any # The namespace of the organization where the logo should be updated., file: any # An image containing the new logo.}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/organizations/{organizationId}/logo\n@desc Delete organization logo\n@required {organizationId: any # The namespace of the organization where the logo should be deleted.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/messaging\n@required {organizationId: any # organizationId}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PATCH /api/v1/organizations/{organizationId}/messaging\n@required {organizationId: any # organizationId, request: map # request}\n@returns(200) OK\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /api/v1/organizations/{organizationId}/messaging/enqueueCustomMessage\n@desc Enqueue a custom message\n@required {organizationId: any # The organisation namespace, request: map # request}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/partner\n@desc Get partners of an organization\n@required {organizationId: any # The namespace of the organization to query partner organizations}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/organizations/{organizationId}/partner\n@desc Add partner\n@required {organizationId: any # The namespace of the organization, request: map # request}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/organizations/{organizationId}/partner\n@desc Remove partner\n@required {organizationId: any # The namespace of the organization, request: map # request}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/privileges\n@desc List my privileges\n@required {organizationId: any # The namespace of the organization}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/roles\n@desc List users and their roles\n@required {organizationId: any # organizationId}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/users\n@desc Find users in organization\n@required {organizationId: any # organizationId}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/organizations/{organizationId}/users/invite\n@desc Invite Users\n@required {organizationId: any # The namespace of the organization where users should be invited, invitationList: map # invitationList}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/organizations/{organizationId}/users/{username}/roles\n@desc Get user roles by username\n@required {organizationId: any # The namespace of the organization, username: any # username}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint POST /api/v1/organizations/{organizationId}/users/{username}/roles\n@desc Add role(s) to user\n@required {organizationId: any # The namespace of the organization, username: any # username, changeRoleRequest: map # changeRoleRequest}\n@returns(200) OK\n@returns(201) Created\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint DELETE /api/v1/organizations/{organizationId}/users/{username}/roles\n@desc Remove role(s) from user\n@required {organizationId: any # The namespace of the organization, username: any # username, changeRoleRequest: map # changeRoleRequest}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/documents/{id4n}\n@desc List public documents\n@required {id4n: any # id4n}\n@optional {organizationId: any # organizationId, owner: any # Filter by owner organization, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}\n@desc Read public document contents\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata\n@desc Retrieve a public document (meta-data only, no content)\n@required {organizationId: any # organizationId, id4n: any # id4n, fileName: any # fileName}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/history/{id4n}\n@desc Shows the public history of the given GUID\n@required {id4n: any # GUID to retrieve the history for}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/image/{imageID}\n@desc Resolve image\n@required {imageID: any # The id of the image to be resolved.}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/organizations/{organizationId}\n@desc Read public organization information\n@required {organizationId: any # Organization ID}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/public/routes/{id4n}\n@desc Retrieve all public routes for a GUID\n@required {id4n: any # id4n, type: any # type}\n@optional {interpolate: any # interpolate}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/roles\n@desc List roles\n@optional {privilege: any # If specified the roles will be filtered containing that privilege., offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/routingfiles/{id4n}\n@desc Retrieve routing file\n@required {id4n: any # id4n}\n@optional {organizationId: any # organizationId}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/routingfiles/{id4n}\n@desc Store routing file\n@required {rfr: map # rfr, id4n: any # id4n}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/routingfiles/{id4n}/route/{type}\n@desc Retrieve current route of a GUID (or ID4N)\n@required {id4n: any # id4n, type: any # The type of route you want to have}\n@optional {privateRoutes: any # privateRoutes, publicRoutes: any # publicRoutes, interpolate: any # interpolate}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/routingfiles/{id4n}/routes/{type}\n@desc Retrieve all routes of a GUID (or ID4N)\n@required {id4n: any # id4n, type: any # The type of route you want to have}\n@optional {organizationId: any # organizationId, interpolate: any # interpolate}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/search/guids\n@desc Search for GUIDs by alias\n@required {alias: any # The alias to search for, aliasType: any # Alias type type to search for}\n@optional {offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/search/guids/aliases/types\n@desc List all supported alias types\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/transfers/{id4n}/receiveInfo\n@desc Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership\n@required {id4n: any # This ID4N identifies the object to take hold of, request: map # Required information to receive an id4n object}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/transfers/{id4n}/sendInfo\n@desc Show transfer preparation information\n@required {id4n: any # The ID4N to retrieve information about}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint PUT /api/v1/transfers/{id4n}/sendInfo\n@desc Prepare an object for transfer\n@required {id4n: any # The ID4N to prepare for transfer, request: map # Transfer preparation status}\n@returns(200) OK\n@returns(202) Accepted\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/user/organizations\n@desc Retrieve organizations of user\n@optional {role: any # role, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/users\n@desc Find users\n@optional {usernamePrefix: any, offset: any # Start with the n-th element, limit: any # The maximum count of returned elements}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endpoint GET /api/v1/users/{username}\n@desc Find by username\n@required {username: any # username}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endgroup\n\n@group go\n@endpoint GET /go/{guid}\n@desc Forward\n@required {guid: any # guid}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endgroup\n\n@group login\n@endpoint POST /login\n@desc ID4i API Login\n@required {account-credentials: map}\n@returns(200) OK\n@errors {401: Unauthorized}\n\n@endgroup\n\n@group whois\n@endpoint GET /whois/{id4n}\n@desc Resolve owner of id4n\n@required {id4n: any # id4n}\n@returns(200) OK\n@returns(202) Accepted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 405: Method not allowed, 406: Not Acceptable, 415: Unsupported Media Type, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}