schemas:
# bLink specific schemas
## /directory
+ pagedDirectoryClientItems:
+ title: Paged Directory Client Items
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/directoryClientItem'
+ pagination:
+ $ref: '#/components/schemas/pagination'
directoryClientItem:
title: Directory Client Item
allOf:
- required:
- clientId
type: object
properties:
clientId:
type: string
example: CIDX1234567890
- $ref: '#/components/schemas/directoryParticipantItem'
+ pagedDirectoryProviderItems:
+ title: Paged Directory Provider Items
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/directoryProviderItem'
+ pagination:
+ $ref: '#/components/schemas/pagination'
directoryProviderItem:
title: Directory Provider Item
allOf:
- required:
- providerId
type: object
properties:
providerId:
type: string
example: IIDX1234567890
- $ref: '#/components/schemas/directoryParticipantItem'
directoryParticipantItem:
title: Directory Participant Item
required:
- - companyLogo
- status
- companyName
+ - companyNameAbbreviation
- companyUrl
+ - productName
+ - productInfoUrl
- contact
- - marketingDescription
- - shortDescription
- - software
- registrationDate
- lastModified
type: object
properties:
status:
$ref: '#/components/schemas/directoryParticipantStatus'
companyName:
maxLength: 50
type: string
example: ACME
+ companyNameAbbreviation:
+ maxLength: 50
+ type: string
+ description: Abbreviation of company name for mobile applications
+ example: ACME
companyUrl:
type: string
example: https://www.acme.com
- marketingDescription:
- $ref: '#/components/schemas/directoryMarketingDescription'
- shortDescription:
- $ref: '#/components/schemas/directoryShortDescription'
+ productName:
+ maxLength: 50
+ type: string
+ description: Product name of client
+ example: ACME accounting software
+ productInfoUrl:
+ type: string
+ example: https://acme.com/amce_accounting
+ description: Product Url of client
contact:
type: array
example:
- type: BUSINESS
designation: Account and Payments Services
emailAddress: business-contact@acme.com
- type: TECHNICAL
emailAddress: technical-contact@acme.com
phone: +41 58 999 9999
- type: SUPPORT
emailAddress: support-contact@acme.com
phone: +41 58 999 9997
items:
$ref: '#/components/schemas/directoryContact'
- companyLogo:
- $ref: '#/components/schemas/directoryMultisizeImageReference'
- marketingImage:
- $ref: '#/components/schemas/directoryImageReference'
+ logo:
+ $ref: '#/components/schemas/directoryImage'
+ icon:
+ $ref: '#/components/schemas/directoryImage'
registrationDate:
type: string
format: date
example: 2018-04-13
lastModified:
type: string
format: date-time
example: 2018-04-13T11:11:11Z
- software:
- $ref: '#/components/schemas/directorySoftwareDescription'
useCases:
...
directoryContact:
emailAddress:
- maxLength: 50
+ maxLength: 80
type: string
format: email
...
- directorySoftwareDescription:
- title: Directory Software Description
- required:
- - category
- - manufacturer
- - marketingDescription
- - productInfoUrl
- - productLogo
- - productName
- - shortDescription
- type: object
- properties:
- productName:
- $ref: '#/components/schemas/directoryProductName'
- manufacturer:
- maxLength: 50
- type: string
- example: ACME Corp.
- category:
- minItems: 1
- type: array
- example:
- - ACCOUNTING
- items:
- type: string
- enum:
- - ACCOUNTING
- - IT
- - CRM
- productInfoUrl:
- type: string
- example: https://acme.com/amce_accounting
- productLogo:
- $ref: '#/components/schemas/directoryMultisizeImageReference'
- marketingImage:
- $ref: '#/components/schemas/directoryImageReference'
- marketingDescription:
- $ref: '#/components/schemas/directoryMarketingDescription'
- shortDescription:
- $ref: '#/components/schemas/directoryShortDescription'
- directoryMarketingDescription:
- title: Directory Marketing Description
- required:
- - de
- - en
- - fr
- - it
- type: object
- properties:
- de:
- type: array
- items:
- maxLength: 140
- type: string
- en:
- type: array
- items:
- maxLength: 140
- type: string
- fr:
- type: array
- items:
- maxLength: 140
- type: string
- it:
- type: array
- items:
- maxLength: 140
- type: string
- example:
- de:
- - bullet1
- - bullet2
- - bullet3
- - bullet4
- - bullet5
- en:
- - bullet1
- - bullet2
- - bullet3
- - bullet4
- - bullet5
- fr:
- - bullet1
- - bullet2
- - bullet3
- - bullet4
- - bullet5
- it:
- - bullet1
- - bullet2
- - bullet3
- - bullet4
- - bullet5
- directoryShortDescription:
- title: Directory Short Description
- required:
- - de
- - en
- - fr
- - it
- type: object
- properties:
- de:
- maxLength: 300
- type: string
- en:
- maxLength: 300
- type: string
- fr:
- maxLength: 300
- type: string
- it:
- maxLength: 300
- type: string
- example:
- de: Kurzbeschreibung
- en: Short description
- fr: Description rapide
- it: Corta descrizione
directoryUseCaseItem:
...
properties:
type: object
additionalProperties:
type: string
- endpointInfos:
- type: array
- items:
- $ref: '#/components/schemas/directoryEndpointInfo'
- directoryProductName:
- title: Directory Product Name
- required:
- - de
- - en
- - fr
- - it
- type: object
- properties:
- de:
- maxLength: 50
- type: string
- en:
- maxLength: 50
- type: string
- fr:
- maxLength: 50
- type: string
- it:
- maxLength: 50
- type: string
- example:
- de: ACME Buchhaltungssoftware
- en: ACME accounting software
- fr: ACME software comptable
- it: ACME software contabilità
- directoryMultisizeImageReference:
- title: Directory Multisize Image Reference
- required:
- - large
- - small
- type: object
- properties:
- small:
- $ref: '#/components/schemas/directoryImageReference'
- large:
- $ref: '#/components/schemas/directoryImageReference'
directoryParticipantStatus:
title: Directory Participant Status
type: string
example: ACTIVE
default: ACTIVE
enum:
- ACTIVE
- INACTIVE
- SUSPENDED
- ONBOARDING_DEVELOPMENT
directoryEmbedAssetType:
title: Embed Asset Type
type: string
- example: LOGO
- default: LOGO
+ example: ALL
+ default: ALL
enum:
- ALL
+ - ICON
- LOGO
- NONE
- directoryImageReference:
- title: Directory Image Reference
- required:
- - assetId
- - mimeType
- type: object
- properties:
- mimeType:
- type: string
- example: image/svg+xml
- image:
- pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
- type: string
- format: byte
- example: QUNNRQ==
- assetId:
- type: string
- format: string
- example: assetId.svg
+ directoryImage:
+ title: Directory Image
+ type: string
+ pattern: '^data:image/svg\+xml;base64,[A-Za-z0-9+/]+=*$'
+ format: base64
+ example: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj4KICA8Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgc3R5bGU9ImZpbGw6cmVkOyIgLz4KPC9zdmc+Cg=='
directoryEndpointInfo:
...
+ pagination:
+ type: object
+ properties:
+ totalCount:
+ type: integer
+ description: |
+ Total number of records, useful for pagination: use offset and limit parameters to query for any given page.
+ As long as the offset is less than totalCount, there will be records in the response. Once offset is larger
+ than totalCount, the response will be empty.
+ example: 100
+ offset:
+ type: integer
+ description: the offset which was requested in the query, or the default used by the server.
+ example: 0
+ limit:
+ type: integer
+ description: the limit which was requested in the query, or the default used by the server.
+ example: 20
## errors
commonErrorResponse:
