diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index 196a5b3..504ee8f 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -17,10 +17,10 @@ paths: get: tags: - Customers - summary: Get a single customer profile based on search parameters + summary: Get a customer profile based on search parameters description: | - Get a single customer profile based on search parameters. Only returns a profile if a single result matches - the parameters; when multiple results are found, additional search parameters are required to disambiguate. + Get a profile based on search parameters. Only returns a profile if a single result matches for a customer + the parameters; when multiple results are found, additional search parameters are required to disambiguate. If role is klantenservice, multiple customers can be returned. parameters: - name: customerProfileId in: query @@ -140,7 +140,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CustomersResponse" + $ref: "#/components/schemas/CustomersResponseList" "404": description: No customer found content: @@ -3257,211 +3257,218 @@ components: alias: type: string example: MyNewToken - CustomersResponse: + CustomersResponseList: type: object properties: - customerProfileId: - type: integer - example: 1 - customerNumber: - type: integer - example: 1000001 - customerStatus: - type: object - properties: - customerStatusId: - type: integer - example: 1 - name: - type: string - example: Active - debtorNumber: - type: string - example: DB100001 - debtorStatus: - type: object - properties: - debtorStatusId: - type: integer - example: 1 - name: - type: string - example: Active - person: - type: object - properties: - prefix: - type: string - example: Mr - birthname: - type: string - example: John - surname: - type: string - example: Doe - suffix: - type: string - example: Jr. - dateOfBirth: - type: string - format: date - example: "2023-02-01" - emailAddress: - type: string - format: email - example: 4j2dD@example.com - addresses: - type: array - items: + customers: + type: array + items: + $ref: "#/components/schemas/CustomersResponse" + CustomersResponse: + type: object + properties: + customerProfileId: + type: integer + example: 1 + customerNumber: + type: integer + example: 1000001 + customerStatus: + type: object + properties: + customerStatusId: + type: integer + example: 1 + name: + type: string + example: Active + debtorNumber: + type: string + example: DB100001 + debtorStatus: + type: object + properties: + debtorStatusId: + type: integer + example: 1 + name: + type: string + example: Active + person: + type: object + properties: + prefix: + type: string + example: Mr + birthname: + type: string + example: John + surname: + type: string + example: Doe + suffix: + type: string + example: Jr. + dateOfBirth: + type: string + format: date + example: "2023-02-01" + emailAddress: + type: string + format: email + example: 4j2dD@example.com + addresses: + type: array + items: + type: object + properties: + addressId: + type: integer + example: 1 + addressType: + type: object + properties: + addressTypeId: + type: integer + example: 1 + name: + type: string + example: Shipping + street: + type: string + example: Appelstraat + houseNumber: + type: integer + example: 1 + houseNumberSuffix: + type: string + example: BS + postalCode: + type: string + example: 1234AB + city: + type: string + example: Den Haag + country: + type: string + example: NL + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1 + method: + type: string + example: GET + delete_address: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1 + method: + type: string + example: DELETE + phones: + type: array + items: + type: object + properties: + phoneId: + type: integer + example: 1 + isPreferred: + type: boolean + example: true + phoneType: + type: object + properties: + phoneTypeId: + type: integer + example: 1 + name: + type: string + example: Home + number: + type: string + example: "0123456789" + countryCode: + type: string + example: "0031" + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1 + method: + type: string + example: GET + delete_phone: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1 + method: + type: string + example: DELETE + _links: + type: object + properties: + self: type: object properties: - addressId: - type: integer - example: 1 - addressType: - type: object - properties: - addressTypeId: - type: integer - example: 1 - name: - type: string - example: Shipping - street: + href: type: string - example: Appelstraat - houseNumber: - type: integer - example: 1 - houseNumberSuffix: + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers + method: type: string - example: BS - postalCode: + example: GET + create_customer_status: + type: object + description: ONLY ALLOWED FOR SMP - Create a new customer status + properties: + href: type: string - example: 1234AB - city: + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/statuses + method: type: string - example: Den Haag - country: - type: string - example: NL - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1 - method: - type: string - example: GET - delete_address: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1 - method: - type: string - example: DELETE - phones: - type: array - items: + example: POST + partial_edit: type: object properties: - phoneId: - type: integer - example: 1 - isPreferred: - type: boolean - example: true - phoneType: - type: object - properties: - phoneTypeId: - type: integer - example: 1 - name: - type: string - example: Home - number: + href: type: string - example: "0123456789" - countryCode: + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers + method: type: string - example: "0031" - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1 - method: - type: string - example: GET - delete_phone: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1 - method: - type: string - example: DELETE - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers - method: - type: string - example: GET - create_customer_status: - type: object - description: ONLY ALLOWED FOR SMP - Create a new customer status - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/statuses - method: - type: string - example: POST - partial_edit: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers - method: - type: string - example: PATCH - get_tokens: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens - method: - type: string - example: GET - create_token: - type: object - properties: - href: - type: string - example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens - method: - type: string - example: POST + example: PATCH + get_tokens: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens + method: + type: string + example: GET + create_token: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens + method: + type: string + example: POST OvPayTokensResponse: type: object required: