POST api/Mandate/GetForm

Get a mandate form from the system

Request Information

URI Parameters

None.

Body Parameters

FormRequest
NameDescriptionTypeAdditional information
FormID

integer

None.

FromTime

date

None.

ToTime

date

None.

OnlyEnabled

boolean

None.

Username

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FormID": 1,
  "FromTime": "2022-07-01T07:48:05.693758+00:00",
  "ToTime": "2022-07-01T07:48:05.693758+00:00",
  "OnlyEnabled": true,
  "Username": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample:
<FormRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization">
  <Password>sample string 4</Password>
  <Username>sample string 3</Username>
  <FormID>1</FormID>
  <FromTime>2022-07-01T07:48:05.693758+00:00</FromTime>
  <OnlyEnabled>true</OnlyEnabled>
  <ToTime>2022-07-01T07:48:05.693758+00:00</ToTime>
</FormRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MandateFormInfo
NameDescriptionTypeAdditional information
FormID

integer

None.

Name

string

None.

Description

string

None.

FormString

string

None.

Attributes

Collection of string

None.

ExtraAttrName

string

None.

ExtraAttrID

string

None.

ExtraAttrPlaceholder

string

None.

Receiver

boolean

None.

Added

date

None.

Edited

date

None.

Enabled

boolean

None.

Visible

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "FormID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "FormString": "sample string 4",
  "Attributes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExtraAttrName": "sample string 5",
  "ExtraAttrID": "sample string 6",
  "ExtraAttrPlaceholder": "sample string 7",
  "Receiver": true,
  "Added": "2022-07-01T07:48:05.6953145+00:00",
  "Edited": "2022-07-01T07:48:05.6953145+00:00",
  "Enabled": true,
  "Visible": true
}

application/xml, text/xml

Sample:
<MandateFormInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization">
  <Added>2022-07-01T07:48:05.6953145+00:00</Added>
  <Attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Attributes>
  <Description>sample string 3</Description>
  <Edited>2022-07-01T07:48:05.6953145+00:00</Edited>
  <Enabled>true</Enabled>
  <ExtraAttrID>sample string 6</ExtraAttrID>
  <ExtraAttrName>sample string 5</ExtraAttrName>
  <ExtraAttrPlaceholder>sample string 7</ExtraAttrPlaceholder>
  <FormID>1</FormID>
  <FormString>sample string 4</FormString>
  <Name>sample string 2</Name>
  <Receiver>true</Receiver>
  <Visible>true</Visible>
</MandateFormInfo>