Order-Service API Documentation API Reference

This document describes the hepster order api.

Version: 0.5

Authentication

basicAuth

type
basic

Paths

POST /v1/certificates/{certificateUUID}/cases/{caseUUID}/attachments

certificateUUID: string
in path

(no description)

caseUUID: string
in path

(no description)

attachment: file
in formData

(no description)

200 OK

OK
basicAuth

GET /v1/certificates/{certificateUUID}/cases/{caseUUID}/status

certificateUUID: string
in path

(no description)

caseUUID: string
in path

(no description)

200 OK
CaseStatusDto

OK

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "createdDate": "string (date-time)",
  "updatedAt": "string (date-time)",
  "status": "string"
}
basicAuth

GET /v1/certificates/{certificateUUID}/cases

certificateUUID: string (uuid)
in path

(no description)

200 OK
CaseStatusDto

OK

type
CaseStatusDto
Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "createdDate": "string (date-time)",
    "updatedAt": "string (date-time)",
    "status": "string"
  }
]
basicAuth

POST /v1/certificates/{certificateUUID}/cases

CaseDto

undefined

certificateUUID: string
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "certificateHolder": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "phone": "string",
    "dateOfBirth": "string (date-time)"
  },
  "damageLocation": {
    "location": "string",
    "zipCode": "string",
    "city": "string",
    "country": "string",
    "time": "string (date-time)",
    "description": "string"
  },
  "damageReport": "string",
  "receivableUuid": "string (uuid)",
  "caseData": "object",
  "serviceProviderId": "string"
}
200 OK
DamageReportResponseDto

OK

Response Example (200 OK) 
{
  "id": "string (uuid)"
}
basicAuth

GET /v1/certificates

certificateNumber: string
in query

(no description)

firstName: string
in query

(no description)

lastName: string
in query

(no description)

company: string
in query

(no description)

target: string INSURANCE_USER, CUSTOMER
in query

(no description)

200 OK
CertificateDto

OK

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "contractId": "string (uuid)",
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "email": "string",
    "birthDate": "string (date-time)"
  },
  "order": {
    "id": "string (uuid)",
    "orderDate": "string (date-time)",
    "salesPartnerId": "integer (int64)",
    "salesChannel": "string",
    "partnerId": "string (uuid)"
  },
  "productId": "string (uuid)",
  "qualityId": "string (uuid)",
  "coverageSum": "number",
  "coverageDuration": "integer (int32)",
  "coverageEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageType": "string",
  "price": "number",
  "certificateNumber": "string",
  "certificateKey": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contractStartDate": "string (date-time)"
}
basicAuth

POST /v1/contactRequests

ContactRequestDto

undefined

Request Content-Types: application/json
Request Example
{
  "contactGroup": "string",
  "subject": "string",
  "name": "string",
  "position": "string",
  "company": "string",
  "email": "string",
  "phone": "string",
  "message": "string"
}
200 OK
ContactRequestResponseDto

OK

Response Example (200 OK) 
{
  "externalId": "string"
}
basicAuth

Schema Definitions

CaseStatusDto: object

id: string (uuid)
createdDate: string (date-time)
updatedAt: string (date-time)
status: string
Example
{
  "id": "string (uuid)",
  "createdDate": "string (date-time)",
  "updatedAt": "string (date-time)",
  "status": "string"
}

CertificateDto: object

id: string (uuid)
contractId: string (uuid)
customer: SimplifiedCustomerDto
order: SimplifiedOrderDto
productId: string (uuid)
qualityId: string (uuid)
coverageSum: number
coverageDuration: integer (int32)
coverageEndDate: string (date-time)
coverageAmount: integer (int32) x ≥ 1
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
coverageType: string THING, PERSON, EVENT
price: number
certificateNumber: string
certificateKey: string
policyAttributes: PolicyAttributeDto
PolicyAttributeDto
contractStartDate: string (date-time)
Example
{
  "id": "string (uuid)",
  "contractId": "string (uuid)",
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "email": "string",
    "birthDate": "string (date-time)"
  },
  "order": {
    "id": "string (uuid)",
    "orderDate": "string (date-time)",
    "salesPartnerId": "integer (int64)",
    "salesChannel": "string",
    "partnerId": "string (uuid)"
  },
  "productId": "string (uuid)",
  "qualityId": "string (uuid)",
  "coverageSum": "number",
  "coverageDuration": "integer (int32)",
  "coverageEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageType": "string",
  "price": "number",
  "certificateNumber": "string",
  "certificateKey": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contractStartDate": "string (date-time)"
}

PolicyAttributeDto: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

SimplifiedCustomerDto: object

firstName: string
lastName: string
company: string
email: string
birthDate: string (date-time)
Example
{
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "email": "string",
  "birthDate": "string (date-time)"
}

SimplifiedOrderDto: object

id: string (uuid)
orderDate: string (date-time)
salesPartnerId: integer (int64)
salesChannel: string
partnerId: string (uuid)
Example
{
  "id": "string (uuid)",
  "orderDate": "string (date-time)",
  "salesPartnerId": "integer (int64)",
  "salesChannel": "string",
  "partnerId": "string (uuid)"
}

ContactRequestResponseDto: object

externalId: string
Example
{
  "externalId": "string"
}

ContactRequestDto: object

contactGroup: string CUSTOMER, BUSINESS
subject: string
name: string
position: string
company: string
email: string
phone: string
message: string
Example
{
  "contactGroup": "string",
  "subject": "string",
  "name": "string",
  "position": "string",
  "company": "string",
  "email": "string",
  "phone": "string",
  "message": "string"
}

DamageReportResponseDto: object

id: string (uuid)
Example
{
  "id": "string (uuid)"
}

CaseDto: object

certificateHolder: InvolvedPersonDto
damageLocation: DamageLocationDto
damageReport: string
receivableUuid: string (uuid)
caseData: object
serviceProviderId: string
Example
{
  "certificateHolder": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "phone": "string",
    "dateOfBirth": "string (date-time)"
  },
  "damageLocation": {
    "location": "string",
    "zipCode": "string",
    "city": "string",
    "country": "string",
    "time": "string (date-time)",
    "description": "string"
  },
  "damageReport": "string",
  "receivableUuid": "string (uuid)",
  "caseData": "object",
  "serviceProviderId": "string"
}

DamageLocationDto: object

location: string
zipCode: string
city: string
country: string
time: string (date-time)
description: string
Example
{
  "location": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "time": "string (date-time)",
  "description": "string"
}

InvolvedPersonDto: object

firstName: string
lastName: string
email: string
street: string
zipCode: string
city: string
phone: string
dateOfBirth: string (date-time)
Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "phone": "string",
  "dateOfBirth": "string (date-time)"
}
Documentation by Spectacle