Mina Meddelanden Rest API - Recipient

Endpoints:
Test: https://far.test.minameddelanden.se/formedlingsregister/v1/mottagare/
Produktion: https://far.minameddelanden.se/formedlingsregister/v1/mottagare/
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

RecipientResource

RecipientResource

Up 
post /isReachable
IsReachable request (isReachable)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IsReachable IsReachable (required)
Body Parameter —

Return type

IsReachableResponse

Example data

Content-Type: application/json
{
  "isReachableResponse" : [ {
    "accountStatus" : "",
    "senderAccepted" : true,
    "lastSenderAcceptChange" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "accountStatus" : "",
    "senderAccepted" : true,
    "lastSenderAcceptChange" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Example data

Content-Type: application/json
{
  "instance" : "instance",
  "detail" : "detail",
  "type" : "type",
  "title" : "title",
  "transactionId" : "transactionId",
  "status" : 0
}

Example data

Content-Type: application/json
{
  "instance" : "instance",
  "detail" : "detail",
  "type" : "type",
  "title" : "title",
  "transactionId" : "transactionId",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success IsReachableResponse

500

Internal Server Error ErrorResponse

400

Bad Request ErrorResponse
Up 
post /isRegistered
IsRegistered request (isRegistered)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IsRegistered IsRegistered (required)
Body Parameter —

Return type

IsRegisteredResponse

Example data

Content-Type: application/json
{
  "isRegisteredResponse" : [ {
    "lastRegistration" : "2000-01-23T04:56:07.000+00:00",
    "pending" : true,
    "serviceSupplier" : "",
    "recipientId" : "recipientId",
    "type" : "type"
  }, {
    "lastRegistration" : "2000-01-23T04:56:07.000+00:00",
    "pending" : true,
    "serviceSupplier" : "",
    "recipientId" : "recipientId",
    "type" : "type"
  } ]
}

Example data

Content-Type: application/json
{
  "instance" : "instance",
  "detail" : "detail",
  "type" : "type",
  "title" : "title",
  "transactionId" : "transactionId",
  "status" : 0
}

Example data

Content-Type: application/json
{
  "instance" : "instance",
  "detail" : "detail",
  "type" : "type",
  "title" : "title",
  "transactionId" : "transactionId",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success IsRegisteredResponse

500

Internal Server Error ErrorResponse

400

Bad Request ErrorResponse

Models

[ Jump to Methods ]

Table of Contents

  1. AccountStatus -
  2. ErrorResponse -
  3. IsReachable -
  4. IsReachableResponse -
  5. IsRegistered -
  6. IsRegisteredResponse -
  7. ReachabilityStatus -
  8. ServiceSupplier -

AccountStatus - Up

type
String Account type
recipientId
String Recipient ID
pending
Boolean
serviceSupplier (optional)
ServiceSupplier
lastRegistration (optional)
Date format: date-time

ErrorResponse - Up

type (optional)
String URI that links to the documentation of the error code that is returned in title.
title (optional)
String Description of the error type. Returns an error code and description
status (optional)
Integer HTTP status code
detail (optional)
String Message detailing what is wrong.
instance (optional)
String URI defining the resource
transactionId (optional)
String Unique correlationID for this request chain

IsReachable - Up

senderOrgNr
String Sender organization number
recipientId
array[String] Recipient ID

IsReachableResponse - Up

isReachableResponse (optional)
array[ReachabilityStatus]

IsRegistered - Up

recipientId
array[String] Recipient ID

IsRegisteredResponse - Up

isRegisteredResponse (optional)
array[AccountStatus]

ReachabilityStatus - Up

accountStatus
AccountStatus
senderAccepted
Boolean
lastSenderAcceptChange (optional)
Date format: date-time

ServiceSupplier - Up

name
String Service supplier name
id
String Service supplier endpoint address
logo (optional)
URI Service supplier logo address format: uri
serviceAddress
URI Service supplier service address format: uri
UIAddress (optional)
URI Service supplier UI address format: uri
internalServiceAddress
URI Service supplier internal address format: uri