POST api/Mandate/GetMandates

Get mandates from the system with search criteria

Request Information

URI Parameters

None.

Body Parameters

The request

MandateRequest
NameDescriptionTypeAdditional information
MandateID

string

None.

GiverSSN

string

None.

HolderSSN

string

None.

OnBehalfSSN

string

None.

FromTime

date

None.

ToTime

date

None.

FormID

integer

None.

OnlyValid

boolean

None.

Username

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MandateID": "sample string 1",
  "GiverSSN": "sample string 2",
  "HolderSSN": "sample string 3",
  "OnBehalfSSN": "sample string 4",
  "FromTime": "2024-12-10T23:00:32.8131836+00:00",
  "ToTime": "2024-12-10T23:00:32.8131836+00:00",
  "FormID": 5,
  "OnlyValid": true,
  "Username": "sample string 7",
  "Password": "sample string 8"
}

application/xml, text/xml

Sample:
<MandateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization">
  <Password>sample string 8</Password>
  <Username>sample string 7</Username>
  <FormID>5</FormID>
  <FromTime>2024-12-10T23:00:32.8131836+00:00</FromTime>
  <GiverSSN>sample string 2</GiverSSN>
  <HolderSSN>sample string 3</HolderSSN>
  <MandateID>sample string 1</MandateID>
  <OnBehalfSSN>sample string 4</OnBehalfSSN>
  <OnlyValid>true</OnlyValid>
  <ToTime>2024-12-10T23:00:32.8131836+00:00</ToTime>
</MandateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MandateData
NameDescriptionTypeAdditional information
ID

globally unique identifier

None.

HolderSSN

Collection of string

None.

OnbehalfSSN

Collection of string

None.

GiverSSN

Collection of string

None.

Document

Collection of byte

None.

DocumentContent

string

None.

Data

Dictionary of string [key] and string [value]

None.

Added

date

None.

Signed

date

None.

ValidFrom

date

None.

ValidTo

date

None.

FormName

string

None.

FormID

integer

None.

State

AuthorizationState

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "c47a338c-9dfc-45b1-ae8a-0f383d587fcd",
    "HolderSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "OnbehalfSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "GiverSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "Document": "QEA=",
    "DocumentContent": "sample string 2",
    "Data": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Added": "2024-12-10T23:00:32.8131836+00:00",
    "Signed": "2024-12-10T23:00:32.8131836+00:00",
    "ValidFrom": "2024-12-10T23:00:32.8131836+00:00",
    "ValidTo": "2024-12-10T23:00:32.8131836+00:00",
    "FormName": "sample string 4",
    "FormID": 5,
    "State": 0
  },
  {
    "ID": "c47a338c-9dfc-45b1-ae8a-0f383d587fcd",
    "HolderSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "OnbehalfSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "GiverSSN": [
      "sample string 1",
      "sample string 2"
    ],
    "Document": "QEA=",
    "DocumentContent": "sample string 2",
    "Data": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Added": "2024-12-10T23:00:32.8131836+00:00",
    "Signed": "2024-12-10T23:00:32.8131836+00:00",
    "ValidFrom": "2024-12-10T23:00:32.8131836+00:00",
    "ValidTo": "2024-12-10T23:00:32.8131836+00:00",
    "FormName": "sample string 4",
    "FormID": 5,
    "State": 0
  }
]

application/xml, text/xml

Sample:
<ArrayOfMandateData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization">
  <MandateData>
    <Added>2024-12-10T23:00:32.8131836+00:00</Added>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Data>
    <Document>QEA=</Document>
    <DocumentContent>sample string 2</DocumentContent>
    <FormID>5</FormID>
    <FormName>sample string 4</FormName>
    <GiverSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </GiverSSN>
    <HolderSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </HolderSSN>
    <ID>c47a338c-9dfc-45b1-ae8a-0f383d587fcd</ID>
    <OnbehalfSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </OnbehalfSSN>
    <Signed>2024-12-10T23:00:32.8131836+00:00</Signed>
    <State>Issuance</State>
    <ValidFrom>2024-12-10T23:00:32.8131836+00:00</ValidFrom>
    <ValidTo>2024-12-10T23:00:32.8131836+00:00</ValidTo>
  </MandateData>
  <MandateData>
    <Added>2024-12-10T23:00:32.8131836+00:00</Added>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Data>
    <Document>QEA=</Document>
    <DocumentContent>sample string 2</DocumentContent>
    <FormID>5</FormID>
    <FormName>sample string 4</FormName>
    <GiverSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </GiverSSN>
    <HolderSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </HolderSSN>
    <ID>c47a338c-9dfc-45b1-ae8a-0f383d587fcd</ID>
    <OnbehalfSSN xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </OnbehalfSSN>
    <Signed>2024-12-10T23:00:32.8131836+00:00</Signed>
    <State>Issuance</State>
    <ValidFrom>2024-12-10T23:00:32.8131836+00:00</ValidFrom>
    <ValidTo>2024-12-10T23:00:32.8131836+00:00</ValidTo>
  </MandateData>
</ArrayOfMandateData>