GET Api/v{apiVersion}/Maps/{id}/Mediums?query={query}&pageSize={pageSize}¤tPage={currentPage}&orderBy={orderBy}&descending={descending}
Gets a list of areas
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| query | string |
Default value is |
|
| pageSize | integer |
None. |
|
| currentPage | integer |
None. |
|
| orderBy | string |
Default value is |
|
| descending | boolean |
None. |
|
| apiVersion | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of MediumPreview| Name | Description | Type | Additional information |
|---|---|---|---|
| MediumID | globally unique identifier |
None. |
|
| Supplier | SupplierPreview |
None. |
|
| Category | CategoryPreview |
None. |
|
| Name | string |
None. |
|
| Type | MediumType |
None. |
|
| SpreadType | SpreadType |
None. |
|
| Status | MediumStatus |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"MediumID": "8a098422-762d-4548-97c7-fec95d039650",
"Supplier": {
"SupplierID": "4070eabd-ad18-4be2-b79e-e45d7dee4957",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Category": {
"CategoryID": "65ff7c8f-b0d5-4639-a672-a0df2e8ba57c",
"MediumType": "Print",
"Name": "sample string 2",
"Status": "InActive"
},
"Name": "sample string 2",
"Type": "Print",
"SpreadType": "AdLocations",
"Status": "InActive"
},
{
"MediumID": "8a098422-762d-4548-97c7-fec95d039650",
"Supplier": {
"SupplierID": "4070eabd-ad18-4be2-b79e-e45d7dee4957",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Category": {
"CategoryID": "65ff7c8f-b0d5-4639-a672-a0df2e8ba57c",
"MediumType": "Print",
"Name": "sample string 2",
"Status": "InActive"
},
"Name": "sample string 2",
"Type": "Print",
"SpreadType": "AdLocations",
"Status": "InActive"
}
]
application/xml, text/xml
Sample:
<ArrayOfMediumPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
<MediumPreview>
<Category>
<CategoryID>65ff7c8f-b0d5-4639-a672-a0df2e8ba57c</CategoryID>
<MediumType>Print</MediumType>
<Name>sample string 2</Name>
<Status>InActive</Status>
</Category>
<MediumID>8a098422-762d-4548-97c7-fec95d039650</MediumID>
<Name>sample string 2</Name>
<SpreadType>AdLocations</SpreadType>
<Status>InActive</Status>
<Supplier>
<Contact>sample string 5</Contact>
<IsBackendSupplier>true</IsBackendSupplier>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 6</PhoneNumber>
<Status>InActive</Status>
<SupplierID>4070eabd-ad18-4be2-b79e-e45d7dee4957</SupplierID>
</Supplier>
<Type>Print</Type>
</MediumPreview>
<MediumPreview>
<Category>
<CategoryID>65ff7c8f-b0d5-4639-a672-a0df2e8ba57c</CategoryID>
<MediumType>Print</MediumType>
<Name>sample string 2</Name>
<Status>InActive</Status>
</Category>
<MediumID>8a098422-762d-4548-97c7-fec95d039650</MediumID>
<Name>sample string 2</Name>
<SpreadType>AdLocations</SpreadType>
<Status>InActive</Status>
<Supplier>
<Contact>sample string 5</Contact>
<IsBackendSupplier>true</IsBackendSupplier>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 6</PhoneNumber>
<Status>InActive</Status>
<SupplierID>4070eabd-ad18-4be2-b79e-e45d7dee4957</SupplierID>
</Supplier>
<Type>Print</Type>
</MediumPreview>
</ArrayOfMediumPreview>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].MediumID" 8a098422-762d-4548-97c7-fec95d039650 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.SupplierID" 4070eabd-ad18-4be2-b79e-e45d7dee4957 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.Contact" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Supplier.PhoneNumber" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Category.CategoryID" 65ff7c8f-b0d5-4639-a672-a0df2e8ba57c --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Category.MediumType" Print --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Category.Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Category.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Type" Print --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].SpreadType" AdLocations --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].MediumID" 8a098422-762d-4548-97c7-fec95d039650 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.SupplierID" 4070eabd-ad18-4be2-b79e-e45d7dee4957 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.Contact" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Supplier.PhoneNumber" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Category.CategoryID" 65ff7c8f-b0d5-4639-a672-a0df2e8ba57c --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Category.MediumType" Print --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Category.Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Category.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Type" Print --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].SpreadType" AdLocations --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e--