GET api/v1/flows?ClientCode={ClientCode}&ProgramCode={ProgramCode}&ExamCode={ExamCode}&CountryCode={CountryCode}&ExamSetId={ExamSetId}&scheduleMethod={scheduleMethod}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientCode | string |
None. |
|
| ProgramCode | string |
None. |
|
| ExamCode | string |
None. |
|
| CountryCode | string |
None. |
|
| ExamSetId | string |
None. |
|
| scheduleMethod | ScheduleMethod |
Default value is Internet |
Body Parameters
None.
Response Information
Resource Description
ResponseWrapperBindingModelOfIEnumerableOfFlows| Name | Description | Type | Additional information |
|---|---|---|---|
| Results | Collection of Flows |
None. |
|
| TotalResults | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalResults": 1,
"Results": [
{
"Id": "sample string 1",
"FlowSet": [
{
"Id": "sample string 1",
"Href": "sample string 2",
"Name": "sample string 3",
"Data": [
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Exams": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"ExtraData": [
{},
{}
],
"Settings": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"Id": "sample string 1",
"Href": "sample string 2",
"Name": "sample string 3",
"Data": [
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Exams": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"ExtraData": [
{},
{}
],
"Settings": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
]
},
{
"Id": "sample string 1",
"FlowSet": [
{
"Id": "sample string 1",
"Href": "sample string 2",
"Name": "sample string 3",
"Data": [
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Exams": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"ExtraData": [
{},
{}
],
"Settings": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"Id": "sample string 1",
"Href": "sample string 2",
"Name": "sample string 3",
"Data": [
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Name": "sample string 1",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ExtraParameters": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Exams": [
{
"Id": "sample string 1",
"Href": "sample string 2"
},
{
"Id": "sample string 1",
"Href": "sample string 2"
}
],
"ExtraData": [
{},
{}
],
"Settings": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
]
}
]
}
application/xml, text/xml
Sample:
<ResponseWrapperBindingModelOfArrayOfFlowsE7G8yWLJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<TotalResults>1</TotalResults>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Orchestration.Infra.Repository.Models">
<d2p1:Flows>
<d2p1:FlowSet>
<d2p1:Flow>
<d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
</d2p1:Data>
<d2p1:Exams>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
</d2p1:Exams>
<d2p1:ExtraData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
<d6p1:anyType />
</d2p1:ExtraData>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Links>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
</d2p1:Links>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Settings xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 1</d6p1:Key>
<d6p1:Value>sample string 2</d6p1:Value>
</d6p1:KeyValueOfstringstring>
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 3</d6p1:Key>
<d6p1:Value>sample string 4</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Settings>
</d2p1:Flow>
<d2p1:Flow>
<d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
</d2p1:Data>
<d2p1:Exams>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
</d2p1:Exams>
<d2p1:ExtraData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
<d6p1:anyType />
</d2p1:ExtraData>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Links>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
</d2p1:Links>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Settings xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 1</d6p1:Key>
<d6p1:Value>sample string 2</d6p1:Value>
</d6p1:KeyValueOfstringstring>
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 3</d6p1:Key>
<d6p1:Value>sample string 4</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Settings>
</d2p1:Flow>
</d2p1:FlowSet>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:Flows>
<d2p1:Flows>
<d2p1:FlowSet>
<d2p1:Flow>
<d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
</d2p1:Data>
<d2p1:Exams>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
</d2p1:Exams>
<d2p1:ExtraData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
<d6p1:anyType />
</d2p1:ExtraData>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Links>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
</d2p1:Links>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Settings xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 1</d6p1:Key>
<d6p1:Value>sample string 2</d6p1:Value>
</d6p1:KeyValueOfstringstring>
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 3</d6p1:Key>
<d6p1:Value>sample string 4</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Settings>
</d2p1:Flow>
<d2p1:Flow>
<d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
<d2p1:Data>
<d2p1:ExtraParameters xmlns:d8p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
<d8p1:KeyValuePairOfstringstring>
<d8p1:key>sample string 1</d8p1:key>
<d8p1:value>sample string 2</d8p1:value>
</d8p1:KeyValuePairOfstringstring>
</d2p1:ExtraParameters>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 1</d8p1:Key>
<d8p1:Value>sample string 2</d8p1:Value>
</d8p1:KeyValueOfstringstring>
<d8p1:KeyValueOfstringstring>
<d8p1:Key>sample string 3</d8p1:Key>
<d8p1:Value>sample string 4</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d2p1:Parameters>
</d2p1:Data>
</d2p1:Data>
<d2p1:Exams>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
<d2p1:ReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ReferenceOfstring>
</d2p1:Exams>
<d2p1:ExtraData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
<d6p1:anyType />
</d2p1:ExtraData>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Links>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Rel>sample string 1</d2p1:Rel>
</d2p1:Link>
</d2p1:Links>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Settings xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 1</d6p1:Key>
<d6p1:Value>sample string 2</d6p1:Value>
</d6p1:KeyValueOfstringstring>
<d6p1:KeyValueOfstringstring>
<d6p1:Key>sample string 3</d6p1:Key>
<d6p1:Value>sample string 4</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Settings>
</d2p1:Flow>
</d2p1:FlowSet>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:Flows>
</Results>
</ResponseWrapperBindingModelOfArrayOfFlowsE7G8yWLJ>