{"openapi":"3.0.0","info":{"title":"NL Monitoring","description":"NL Monitoring API represents the Monitoring of Changes in the Profile of the organizations and branches\n","version":"v0.1.0"},"servers":[{"url":"https://api.company.info","description":"Production Server"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"NL Monitoring API","description":"Calls related to the NL Monitoring API"}],"paths":{"/nl/organizations/monitoring/v1/lists":{"get":{"operationId":"getAllLists","summary":"Get all lists for the customer","tags":["List"],"description":"Get all lists for the customer\n","parameters":[{"name":"page","in":"query","required":false,"style":"deepObject","description":"`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/List"}},"links":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer"},"totalPages":{"type":"integer"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createList","summary":"Create a new monitoring list","tags":["List"],"description":"Create a new monitoring list\n","requestBody":{"description":"List payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBody"}}}},"responses":{"201":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/List"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nl/organizations/monitoring/v1/lists/{list_id}":{"get":{"operationId":"getList","summary":"Get a specific list","tags":["List"],"description":"Get a specific list\n","parameters":[{"name":"list_id","in":"path","required":true,"description":"The ID of the List that will be returned.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/List"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteList","summary":"Delete a list and all its items","tags":["List"],"description":"Delete a list and all its items\n","parameters":[{"name":"list_id","in":"path","required":true,"description":"The ID of the List that will be returned.","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nl/organizations/monitoring/v1/lists/{list_id}/updates":{"get":{"operationId":"getListUpdates","summary":"Get change updates for all items in a list","tags":["List"],"description":"Get change updates for all items in a list\n","parameters":[{"name":"list_id","in":"path","required":true,"description":"The ID of the List that will be returned.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","required":false,"description":"filter the updates","schema":{"$ref":"#/components/schemas/Filter"}},{"name":"page","in":"query","required":false,"style":"deepObject","description":"`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdatesResults"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nl/organizations/monitoring/v1/lists/{list_id}/items":{"get":{"operationId":"getAllListItems","summary":"Get all items in a list","tags":["Item"],"description":"Get all items in a list\n","parameters":[{"name":"list_id","in":"path","required":true,"description":"The ID of the List that will be returned.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"style":"deepObject","description":"`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/List"}},"links":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer"},"totalPages":{"type":"integer"}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createItems","summary":"Add items to a list","tags":["Item"],"description":"Add items to a list\n","parameters":[{"name":"list_id","in":"path","required":true,"description":"The ID of the List that will be returned.","schema":{"type":"string"}}],"requestBody":{"description":"Item payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemBody"}}}},"responses":{"201":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/List"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nl/organizations/monitoring/v1/items/{item_id}":{"get":{"operationId":"getItem","summary":"Get a specific item","tags":["Item"],"description":"Get a specific item\n","parameters":[{"name":"item_id","in":"path","required":true,"description":"The ID of the Item that will be returned.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Item"},"included":{"type":"array","items":{"$ref":"#/components/schemas/List"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteItem","summary":"Delete an item","tags":["Item"],"description":"Delete an item\n","parameters":[{"name":"item_id","in":"path","required":true,"description":"The ID of the Item that will be returned.","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nl/organizations/monitoring/v1/items/{item_id}/updates":{"get":{"operationId":"getItemUpdates","summary":"Get change updates for a specific item","tags":["Item"],"description":"Get change updates for a specific item\n","parameters":[{"name":"item_id","in":"path","required":true,"description":"The ID of the Item that will be returned.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","required":false,"description":"filter the updates","schema":{"$ref":"#/components/schemas/Filter"}},{"name":"page","in":"query","required":false,"style":"deepObject","description":"`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n","schema":{"$ref":"#/components/schemas/Page"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"type":"string","format":"uuid"}}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdatesResults"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"Filter":{"title":"UpdateEventsFilters","type":"object","description":"the list of filters to retrieve update events","properties":{"eventType":{"type":"string","enum":["change"],"example":"change"},"entity":{"type":"object","properties":{"id":{"type":"string","example":"34251678"}}},"date":{"type":"object","properties":{"from":{"type":"string","example":"2024-03-01T00:00:00+01:00"},"to":{"type":"string","example":"2024-03-03T00:00:00+01:00"}}},"collections":{"$ref":"#/components/schemas/CollectionEnum"}}},"List":{"title":"ListAttributes","description":"list attributes","type":"object","properties":{"id":{"type":"string","example":"01HX6V58G64VJHWRDEJF0YKZ85"},"type":{"type":"string","example":"lists"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"List-number-1"},"createdAt":{"type":"string","example":"2024-05-15T13:25:43+02:00"}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"ListBody":{"title":"ListRequestBody","description":"list request body","type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"lists"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"List-number-1"}}}}}}},"UpdatesResults":{"title":"UpdateEventsResult","description":"list of update events","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"01HQ8DJJAZW067WSTRM6M7EWB2"},"type":{"type":"string","example":"updates"},"attributes":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"string","example":"33302047"},"type":{"type":"string","example":"organization"}}},"eventType":{"type":"string","example":"change"},"collection":{"type":"string","example":"activities"},"publishedAt":{"type":"string","example":"2024-05-15T13:25:43+02:00"}}},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string","example":"33302047"}}}}}}}}}},"included":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"organizations"},"id":{"type":"string","example":"33302047"},"attributes":{"type":"object","properties":{"identifiers":{"type":"object","properties":{"tradeRegister":{"type":"object","properties":{"system":{"type":"string","example":"tradeRegister"},"value":{"type":"string","example":"33302047"}}}}}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}}},"links":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}}},"meta":{"type":"object","properties":{"totalResults":{"type":"integer"},"totalPages":{"type":"integer"}}}}},"Item":{"title":"ItemAttributes","description":"item attributes","type":"object","properties":{"id":{"type":"string","example":"01HX71K7DSM0JA59XJZ07MQG2W"},"type":{"type":"string","example":"items"},"attributes":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"string","example":"33302047"},"type":{"type":"string","enum":["organization","branch"],"example":"organization"}}},"eventType":{"type":"string","enum":["change"],"example":"change"},"collections":{"$ref":"#/components/schemas/CollectionEnum"},"createdAt":{"type":"string","example":"2024-05-15T13:25:43+02:00"}}},"relationships":{"type":"object","properties":{"list":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"lists"},"id":{"type":"string","example":"01HX6V58G64VJHWRDEJF0YKZ85"}}}}}}},"links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}}}}},"ItemBody":{"title":"ItemRequestBody","description":"item request body","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"items"},"attributes":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"string","example":"33302047"},"type":{"type":"string","enum":["organization","branch"]}}},"eventType":{"type":"string","enum":["change"],"example":"change"},"collections":{"$ref":"#/components/schemas/CollectionEnum"}}}}}}}},"CollectionEnum":{"description":"All supported collections for organizations and branches","oneOf":[{"$ref":"#/components/schemas/OrganizationCollectionEnum"},{"$ref":"#/components/schemas/BranchCollectionEnum"}]},"OrganizationCollectionEnum":{"title":"OrganizationCollectionEnum","description":"Organization-specific collections","type":"array","items":{"type":"string","example":"activities","enum":["activities","address","authorized-capital","contact","contributed-capital","correspondence-address","dissolution-and-liquidation","extension--activities--company-info","extension--activities--trade-register","extension--activity-summary","extension--contact-person","extension--financials","extension--management","extension--number-of-branches","extension--ownership-structure","extension--size-indicators","insolvency-publications","insolvency-status","issued-capital","legal-form","lifecycle","main-branch","main-branch--activities","main-branch--address","main-branch--contact","main-branch--correspondence-address","main-branch--lifecycle","main-branch--name","main-branch--personnel","main-branch--trade-names","name","rsin","statutory-seat"]}},"BranchCollectionEnum":{"title":"BranchCollectionEnum","description":"Branch-specific collections","type":"array","items":{"type":"string","example":"activities","enum":["activities","address","branch-transfer","contact","correspondence-address","extension--transfers","lifecycle","main-branch","name","personnel","trade-names"]}},"Error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}}}}}},"Page":{"type":"object","properties":{"size":{"type":"integer","default":10,"description":"The number of records to return in each page."},"number":{"type":"integer","default":1,"description":"This parameter specifies the page number."}}},"JSONAPILinkObject":{"title":"JSON:API Link Object","description":"a structured representation of a URL","type":"object","required":["href"],"properties":{"href":{"type":"string","example":"/organizations/<cin>"},"meta":{"type":"object","example":{"count":"10"}}}},"JSONAPILink":{"title":"JSON:API Link","description":"A JSON:API link can be either a URL string or a structured link object.","oneOf":[{"type":"string","format":"url","example":"https://example.com/"},{"$ref":"#/components/schemas/JSONAPILinkObject"}]}}},"x-readme":{"proxy-enabled":false}}