POST api/Mandate/GetMandate
Get a mandate from the system
Request Information
URI Parameters
None.
Body Parameters
The mandate request
MandateRequestName | Description | Type | Additional 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-10T21:17:32.876201+00:00", "ToTime": "2024-12-10T21:17:32.876201+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-10T21:17:32.876201+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-10T21:17:32.876201+00:00</ToTime> </MandateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MandateDataName | Description | Type | Additional 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": "59ab1179-125b-4359-b478-a98488434d49", "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-10T21:17:32.9387164+00:00", "Signed": "2024-12-10T21:17:32.9387164+00:00", "ValidFrom": "2024-12-10T21:17:32.9387164+00:00", "ValidTo": "2024-12-10T21:17:32.9387164+00:00", "FormName": "sample string 4", "FormID": 5, "State": 0 }
application/xml, text/xml
Sample:
<MandateData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Authorization"> <Added>2024-12-10T21:17:32.9387164+00:00</Added> <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </Data> <Document>QEA=</Document> <DocumentContent>sample string 2</DocumentContent> <FormID>5</FormID> <FormName>sample string 4</FormName> <GiverSSN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </GiverSSN> <HolderSSN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </HolderSSN> <ID>59ab1179-125b-4359-b478-a98488434d49</ID> <OnbehalfSSN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </OnbehalfSSN> <Signed>2024-12-10T21:17:32.9387164+00:00</Signed> <State>Issuance</State> <ValidFrom>2024-12-10T21:17:32.9387164+00:00</ValidFrom> <ValidTo>2024-12-10T21:17:32.9387164+00:00</ValidTo> </MandateData>