GET api/v1/store/{storeID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
storeID

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseStoreData
NameDescriptionTypeAdditional information
StoreID

string

None.

BudgetEnabled

boolean

None.

BudgetTypes

Collection of ResponseLookupData

None.

BudgetDuration

Collection of ResponseLookupData

None.

CompanyName

string

None.

_meta

ResponseMeta

None.

Response Formats

application/json, text/json

Sample:
{
  "StoreID": "sample string 1",
  "BudgetEnabled": true,
  "BudgetTypes": [
    {
      "Value": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Value": "sample string 1",
      "Description": "sample string 2"
    }
  ],
  "BudgetDuration": [
    {
      "Value": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Value": "sample string 1",
      "Description": "sample string 2"
    }
  ],
  "CompanyName": "sample string 3",
  "_meta": {
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "ChangeType": "Created"
  }
}

application/xml, text/xml

Sample:
<ResponseStoreData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">
  <BudgetDuration>
    <ResponseLookupData>
      <Description>sample string 2</Description>
      <Value>sample string 1</Value>
    </ResponseLookupData>
    <ResponseLookupData>
      <Description>sample string 2</Description>
      <Value>sample string 1</Value>
    </ResponseLookupData>
  </BudgetDuration>
  <BudgetEnabled>true</BudgetEnabled>
  <BudgetTypes>
    <ResponseLookupData>
      <Description>sample string 2</Description>
      <Value>sample string 1</Value>
    </ResponseLookupData>
    <ResponseLookupData>
      <Description>sample string 2</Description>
      <Value>sample string 1</Value>
    </ResponseLookupData>
  </BudgetTypes>
  <CompanyName>sample string 3</CompanyName>
  <StoreID>sample string 1</StoreID>
  <_meta xmlns:d2p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
    <d2p1:ChangeType>Created</d2p1:ChangeType>
    <d2p1:Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Messages>
  </_meta>
</ResponseStoreData>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.