Reference for https://dna.magnetmail.net/ApiAdapter/Rest/GetRecipientFields/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/GetRecipientFields/
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<AuthCredentials xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects"> <SessionID>String content</SessionID> <UserID>String content</UserID> </AuthCredentials>
The following is an example request Json body:
{
"SessionID":"String content",
"UserID":"String content"
}
The following is an example response Xml body:
<RecipientFields xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">
<CustomFields>
<CustomField>
<FieldName>String content</FieldName>
<Label>String content</Label>
</CustomField>
<CustomField>
<FieldName>String content</FieldName>
<Label>String content</Label>
</CustomField>
</CustomFields>
<EnhancedFields>
<EnhancedField>
<FieldName>String content</FieldName>
<ID>2147483647</ID>
<MappingName>String content</MappingName>
</EnhancedField>
<EnhancedField>
<FieldName>String content</FieldName>
<ID>2147483647</ID>
<MappingName>String content</MappingName>
</EnhancedField>
</EnhancedFields>
<Message>String content</Message>
</RecipientFields>
The following is an example response Json body:
{
"CustomFields":[{
"FieldName":"String content",
"Label":"String content"
}],
"EnhancedFields":[{
"FieldName":"String content",
"ID":2147483647,
"MappingName":"String content"
}],
"Message":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="AuthCredentials">
<xs:sequence>
<xs:element name="SessionID" nillable="true" type="xs:string" />
<xs:element name="UserID" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="AuthCredentials" nillable="true" type="tns:AuthCredentials" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/APIAdapter" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/APIAdapter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="RecipientFields">
<xs:sequence>
<xs:element minOccurs="0" name="CustomFields" nillable="true" type="tns:ArrayOfCustomField" />
<xs:element minOccurs="0" name="EnhancedFields" nillable="true" type="tns:ArrayOfEnhancedField" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="RecipientFields" nillable="true" type="tns:RecipientFields" />
<xs:complexType name="ArrayOfCustomField">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomField" nillable="true" type="tns:CustomField" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomField" nillable="true" type="tns:ArrayOfCustomField" />
<xs:complexType name="CustomField">
<xs:sequence>
<xs:element minOccurs="0" name="FieldName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomField" nillable="true" type="tns:CustomField" />
<xs:complexType name="ArrayOfEnhancedField">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="EnhancedField" nillable="true" type="tns:EnhancedField" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfEnhancedField" nillable="true" type="tns:ArrayOfEnhancedField" />
<xs:complexType name="EnhancedField">
<xs:sequence>
<xs:element minOccurs="0" name="FieldName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ID" type="xs:int" />
<xs:element minOccurs="0" name="MappingName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="EnhancedField" nillable="true" type="tns:EnhancedField" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>