Saves envelope information against a claim
| Name | Description | Additional information |
|---|---|---|
| saveEnvelopesRequest | The save Envelopes Request. |
Define this parameter in the request body. |
{
"ClaimId": 1,
"ClaimEnvelopes": [
{
"ClaimEnvelopeId": 1,
"EnvelopeNumber": "sample string 2",
"PhysicalState": "sample string 1",
"ExcessCharge": "sample string 2",
"ProcessedAfterMarkedLost": "sample string 3"
},
{
"ClaimEnvelopeId": 1,
"EnvelopeNumber": "sample string 2",
"PhysicalState": "sample string 1",
"ExcessCharge": "sample string 2",
"ProcessedAfterMarkedLost": "sample string 3"
},
{
"ClaimEnvelopeId": 1,
"EnvelopeNumber": "sample string 2",
"PhysicalState": "sample string 1",
"ExcessCharge": "sample string 2",
"ProcessedAfterMarkedLost": "sample string 3"
}
]
}
<SaveEnvelopesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Requests">
<ClaimEnvelopes>
<ClaimEnvelopeInfo>
<ClaimEnvelopeId>1</ClaimEnvelopeId>
<EnvelopeNumber>sample string 2</EnvelopeNumber>
<ExcessCharge>sample string 2</ExcessCharge>
<PhysicalState>sample string 1</PhysicalState>
<ProcessedAfterMarkedLost>sample string 3</ProcessedAfterMarkedLost>
</ClaimEnvelopeInfo>
<ClaimEnvelopeInfo>
<ClaimEnvelopeId>1</ClaimEnvelopeId>
<EnvelopeNumber>sample string 2</EnvelopeNumber>
<ExcessCharge>sample string 2</ExcessCharge>
<PhysicalState>sample string 1</PhysicalState>
<ProcessedAfterMarkedLost>sample string 3</ProcessedAfterMarkedLost>
</ClaimEnvelopeInfo>
<ClaimEnvelopeInfo>
<ClaimEnvelopeId>1</ClaimEnvelopeId>
<EnvelopeNumber>sample string 2</EnvelopeNumber>
<ExcessCharge>sample string 2</ExcessCharge>
<PhysicalState>sample string 1</PhysicalState>
<ProcessedAfterMarkedLost>sample string 3</ProcessedAfterMarkedLost>
</ClaimEnvelopeInfo>
</ClaimEnvelopes>
<ClaimId>1</ClaimId>
</SaveEnvelopesRequest>
Sample not available.
{
"Item": {
"OverallResult": true,
"ClaimReferenceNumber": "sample string 2",
"Results": [
{
"Success": true,
"EnvelopeNumber": "sample string 2",
"Reason": "sample string 3"
},
{
"Success": true,
"EnvelopeNumber": "sample string 2",
"Reason": "sample string 3"
},
{
"Success": true,
"EnvelopeNumber": "sample string 2",
"Reason": "sample string 3"
}
]
},
"ResponseInformation": {
"Errors": [
{
"ErrorCode": "sample string 1",
"Message": "sample string 2"
},
{
"ErrorCode": "sample string 1",
"Message": "sample string 2"
},
{
"ErrorCode": "sample string 1",
"Message": "sample string 2"
}
],
"Status": 0,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"IsTemplated": true
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"IsTemplated": true
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"IsTemplated": true
}
]
}
}
<ClaimEnvelopeAttachmentResultsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
<ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
<Errors>
<ApiErrorDetail>
<ErrorCode>sample string 1</ErrorCode>
<Message>sample string 2</Message>
</ApiErrorDetail>
<ApiErrorDetail>
<ErrorCode>sample string 1</ErrorCode>
<Message>sample string 2</Message>
</ApiErrorDetail>
<ApiErrorDetail>
<ErrorCode>sample string 1</ErrorCode>
<Message>sample string 2</Message>
</ApiErrorDetail>
</Errors>
<Links>
<Link>
<Href>sample string 2</Href>
<IsTemplated>true</IsTemplated>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
</Link>
<Link>
<Href>sample string 2</Href>
<IsTemplated>true</IsTemplated>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
</Link>
<Link>
<Href>sample string 2</Href>
<IsTemplated>true</IsTemplated>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
</Link>
</Links>
<Status>Failure</Status>
</ResponseInformation>
<Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
<d2p1:ClaimReferenceNumber>sample string 2</d2p1:ClaimReferenceNumber>
</Item>
</ClaimEnvelopeAttachmentResultsResponse>