Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Tjänsten listar en persons kundrelationer till olika bolag
Livscykelstatus
DesignUnder utveckling
Lösningsbeskrivning
<Infoga en Gliffy-bild som visuellt beskriver lösningen>
Hantering av personuppgifter
<Vilka personuppgifter hanteras och varför?>
API specifikation
Draft:
| Swagger ui | |||
|---|---|---|---|
| ---
openapi: 3.0.2
info:
title: Customer API
description: "API used to get customer-info"
version: 1.0.0
tags:
- name: Customer API endpoints
paths:
/persons/{personId}:
get:
tags:
- Customer API endpoints
summary: Get customers by person-id
parameters:
- name: personId
in: path
description: Person ID
required: true
style: simple
explode: false
schema:
type: string
example: 81471222-5798-11e9-ae24-57fa13b361e1
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
"400":
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceErrorResponse'
"500":
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceErrorResponse'
components:
schemas:
CustomerResponse:
type: object
properties:
id:
type: string
description: Id of Customer
example: '435553'
customerType:
allOf:
- $ref: '#/components/schemas/CustomerType'
- description: Customer type
customerRelations:
type: array
description: Customer relations
items:
required:
- customerId
- organizationId
- organizationName
type: object
properties:
customerId:
type: string
description: Customer Id
example: '81471222'
organizationId:
type: string
description: Organization Id
example: '81471222'
organizationName:
type: string
description: Organization Name
example: '81471222'
CustomerType:
type: string
description: CustomerType model
enum:
- PRIVATE
- ENTERPRISE
ServiceErrorResponse:
type: object
properties:
httpCode:
format: int32
type: integer
message:
type: string
technicalDetails:
$ref: '#/components/schemas/TechnicalDetails'
TechnicalDetails:
type: object
properties:
rootCode:
format: int32
type: integer
rootCause:
type: string
serviceId:
type: string
requestId:
type: string
details:
type: array
items:
type: string
| ||
Säkerhetsklassning
Säkerhetsklass <0, 1, 2, 3, 4>
Autentiseringsmetod: <API Key, Oauth2>Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
<Kontaktuppgifter till utvecklare/teknisk förvaltare>
Länkar
<Länkar till dev-portal;
Test
Sandbox
Produktion>
FAQ
<FAQ>