GET api/v1/Despatch/DES_CR_GET_ApprovedBySite?siteId={siteId}

All Collection requests for the site which have been approved, but not yet despatched.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

The id of the site assigned to the logged in user

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

CollectionRequestSiteModel
NameDescriptionTypeAdditional information
siteid

globally unique identifier

None.
sitename

string

None.
entities

Collection of CollectionRequestSiteEntity

None.

Response Formats

application/json, text/json

Sample: 
{
  "entities": [
    {
      "entityid": "sample string 1",
      "entityname": "sample string 2",
      "entitytype": "sample string 3"
    },
    {
      "entityid": "sample string 1",
      "entityname": "sample string 2",
      "entitytype": "sample string 3"
    }
  ],
  "siteid": "ea5987f1-a437-4744-b34b-82f914ace853",
  "sitename": "sample string 2"
}

application/xml, text/xml

Sample: 
<CollectionRequestSiteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.CollectionRequest">
  <entities>
    <CollectionRequestSiteEntity>
      <entityid>sample string 1</entityid>
      <entityname>sample string 2</entityname>
      <entitytype>sample string 3</entitytype>
    </CollectionRequestSiteEntity>
    <CollectionRequestSiteEntity>
      <entityid>sample string 1</entityid>
      <entityname>sample string 2</entityname>
      <entitytype>sample string 3</entitytype>
    </CollectionRequestSiteEntity>
  </entities>
  <siteid>ea5987f1-a437-4744-b34b-82f914ace853</siteid>
  <sitename>sample string 2</sitename>
</CollectionRequestSiteModel>