GET api/Questionnaire?companyCode={companyCode}&returnOrderIdentifier={returnOrderIdentifier}
Get all RMA Receipt Packages and their given Questionnaires and answeres for a given Return Order.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
Company Identifier |
string |
Required |
| returnOrderIdentifier |
Return Order Identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Response message with requested RMA Receipt Packages, including questionnaires. HttpStatusCode.Conflict when user isn't connected to Company
GetReturnQuestionnaireResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Header item |
MessageHeader |
None. |
| ReturnQuestionnaireResult |
List of Return Orders with questionnaires and given answers |
Collection of QuestionnaireReturnOrder |
None. |
| Footer |
Footer item |
MessageFooter |
None. |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"ReturnQuestionnaireResult": [
{
"ReturnOrderIdentifier": "string 1",
"QuestionnaireReceiptPackages": [
{
"QuestionnaireReceivedProducts": [
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
},
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
}
],
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
},
{
"QuestionnaireReceivedProducts": [
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
},
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
}
],
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
}
]
},
{
"ReturnOrderIdentifier": "string 1",
"QuestionnaireReceiptPackages": [
{
"QuestionnaireReceivedProducts": [
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
},
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
}
],
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
},
{
"QuestionnaireReceivedProducts": [
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
},
{
"ReceiptID": 1,
"QuantityReceived": 2,
"ReturnedLocation": "string 3",
"ReturnedQualityIdentifier": "string 4",
"ProductIdentifier": "string 5",
"InitialQuestionID": 1,
"QuestionsAnswered": [
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
},
{
"QuestionID": 1,
"QuestionDescription": "string 2",
"QuestionLabel": "string 3",
"QuestionType": "string 4",
"Answer": "string 5",
"NextQuestionID": 1
}
]
}
],
"ReturnOrderIdentifier": "string 1",
"CompanyIdentifier": "string 2",
"Quantity": 1,
"QuantitySpecified": true,
"Code": "string 4",
"CodeType": "TrackAndTrace",
"Status": "New"
}
]
}
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<GetReturnQuestionnaireResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header>
<Version>string 1</Version>
<Identification>string 2</Identification>
<Sender>string 3</Sender>
</Header>
<ReturnQuestionnaireResult>
<QuestionnaireReturnOrder>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<QuestionnaireReceiptPackages>
<QuestionnaireReceiptPackage>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
<QuestionnaireReceivedProducts>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
</QuestionnaireReceivedProducts>
</QuestionnaireReceiptPackage>
<QuestionnaireReceiptPackage>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
<QuestionnaireReceivedProducts>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
</QuestionnaireReceivedProducts>
</QuestionnaireReceiptPackage>
</QuestionnaireReceiptPackages>
</QuestionnaireReturnOrder>
<QuestionnaireReturnOrder>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<QuestionnaireReceiptPackages>
<QuestionnaireReceiptPackage>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
<QuestionnaireReceivedProducts>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
</QuestionnaireReceivedProducts>
</QuestionnaireReceiptPackage>
<QuestionnaireReceiptPackage>
<ReturnOrderIdentifier>string 1</ReturnOrderIdentifier>
<CompanyIdentifier>string 2</CompanyIdentifier>
<Quantity>1</Quantity>
<QuantitySpecified>true</QuantitySpecified>
<Code>string 4</Code>
<CodeType>TrackAndTrace</CodeType>
<Status>New</Status>
<QuestionnaireReceivedProducts>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
<QuestionnaireReceivedProduct>
<ReceiptID>1</ReceiptID>
<QuantityReceived>2</QuantityReceived>
<ReturnedLocation>string 3</ReturnedLocation>
<ReturnedQualityIdentifier>string 4</ReturnedQualityIdentifier>
<ProductIdentifier>string 5</ProductIdentifier>
<InitialQuestionID>1</InitialQuestionID>
<QuestionsAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
<QuestionAnswered>
<QuestionID>1</QuestionID>
<QuestionDescription>string 2</QuestionDescription>
<QuestionLabel>string 3</QuestionLabel>
<QuestionType>string 4</QuestionType>
<Answer>string 5</Answer>
<NextQuestionID>1</NextQuestionID>
</QuestionAnswered>
</QuestionsAnswered>
</QuestionnaireReceivedProduct>
</QuestionnaireReceivedProducts>
</QuestionnaireReceiptPackage>
</QuestionnaireReceiptPackages>
</QuestionnaireReturnOrder>
</ReturnQuestionnaireResult>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</GetReturnQuestionnaireResponse>