POST V1/InvoiceRedirection.{ext}/IREmailConfigs
Insert IR Details
Mandatory Fields: RedirectionType, IRMode, Id are Mandatory
If IRMode is 'E-Mail' then EmailAddress is mandatory
If IRMode is 'Mail' then ContactPersonName, Address1, Address2, City, State, Country, ZIP are mandatory
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ext |
Which media types are acceptable for the response, such as json/xml If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter. |
string |
Content-Type: application/json OR application/xml |
Body Parameters
List of IR Email Configuration Details
EMS.Payments.Entities.IREmailConfigDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| IREmailConfigDetailsList |
List of IREmailConfigDetails |
Collection of EMS.Payments.Entities.IREmailConfigDetail |
None. |
Request Formats
application/json, text/json
Sample:
{
"irEmailConfigDetailsList": [
{
"redirectionType": "sample string 1",
"irConfigurationsList": [
{
"irConfigurtionList": [
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
},
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
}
]
},
{
"irConfigurtionList": [
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
},
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
}
]
}
]
},
{
"redirectionType": "sample string 1",
"irConfigurationsList": [
{
"irConfigurtionList": [
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
},
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
}
]
},
{
"irConfigurtionList": [
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
},
{
"irMode": "sample string 1",
"inventoryId": 2,
"id": 3,
"emailAddress": "sample string 4",
"contactPersonName": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"country": "sample string 10",
"zip": "sample string 11",
"siteorAccountNbr": "sample string 12",
"userName": "sample string 13"
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<IREmailConfigDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Payments.Entities">
<IREmailConfigDetailsList>
<IREmailConfigDetail>
<IRConfigurationsList>
<IRConfigurtions>
<IRConfigurtionList>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
</IRConfigurtionList>
</IRConfigurtions>
<IRConfigurtions>
<IRConfigurtionList>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
</IRConfigurtionList>
</IRConfigurtions>
</IRConfigurationsList>
<RedirectionType>sample string 1</RedirectionType>
</IREmailConfigDetail>
<IREmailConfigDetail>
<IRConfigurationsList>
<IRConfigurtions>
<IRConfigurtionList>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
</IRConfigurtionList>
</IRConfigurtions>
<IRConfigurtions>
<IRConfigurtionList>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
<IRConfigurtion>
<Address1>sample string 6</Address1>
<Address2>sample string 7</Address2>
<City>sample string 8</City>
<ContactPersonName>sample string 5</ContactPersonName>
<Country>sample string 10</Country>
<EmailAddress>sample string 4</EmailAddress>
<IRMode>sample string 1</IRMode>
<Id>3</Id>
<InventoryId>2</InventoryId>
<SiteorAccountNbr>sample string 12</SiteorAccountNbr>
<State>sample string 9</State>
<UserName>sample string 13</UserName>
<ZIP>sample string 11</ZIP>
</IRConfigurtion>
</IRConfigurtionList>
</IRConfigurtions>
</IRConfigurationsList>
<RedirectionType>sample string 1</RedirectionType>
</IREmailConfigDetail>
</IREmailConfigDetailsList>
</IREmailConfigDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
Transaction Results
EMSResponseOfEMS.Common.TransactionResults| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseType |
No description available |
string |
None. |
| Response |
No description available |
EMS.Common.TransactionResults |
None. |
| Error |
No description available |
EMS.Common.Error |
None. |
Response Formats
application/json, text/json
Sample:
{
"responseType": "TransactionResults",
"response": {
"transactionResult": [
{
"status": "sample string 1",
"message": "sample string 2",
"result": "sample string 3"
},
{
"status": "sample string 1",
"message": "sample string 2",
"result": "sample string 3"
}
]
},
"error": {
"errorCode": "sample string 1",
"errorDescription": "sample string 2"
}
}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.