POST api/Mandate/GetForms
Get mandate forms from the system
Request Information
URI Parameters
None.
Body Parameters
FormRequestName | Description | Type | Additional 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": "2024-12-11T04:28:23.749307+00:00", "ToTime": "2024-12-11T04:28:23.749307+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>2024-12-11T04:28:23.749307+00:00</FromTime> <OnlyEnabled>true</OnlyEnabled> <ToTime>2024-12-11T04:28:23.749307+00:00</ToTime> </FormRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of MandateFormInfoName | Description | Type | Additional 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": "2024-12-11T04:28:23.749307+00:00", "Edited": "2024-12-11T04:28:23.749307+00:00", "Enabled": true, "Visible": true }, { "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": "2024-12-11T04:28:23.749307+00:00", "Edited": "2024-12-11T04:28:23.749307+00:00", "Enabled": true, "Visible": true } ]
application/xml, text/xml
Sample:
<ArrayOfMandateFormInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization"> <MandateFormInfo> <Added>2024-12-11T04:28:23.749307+00:00</Added> <Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Attributes> <Description>sample string 3</Description> <Edited>2024-12-11T04:28:23.749307+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> <MandateFormInfo> <Added>2024-12-11T04:28:23.749307+00:00</Added> <Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Attributes> <Description>sample string 3</Description> <Edited>2024-12-11T04:28:23.749307+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> </ArrayOfMandateFormInfo>