POST Goals

Request Information

URI Parameters

None.

Body Parameters

IConnect.ReportingApi.Core.GoalsRequest
NameDescriptionTypeAdditional information
ForAllServiceProviders

boolean

None.
Locations

Collection of integer

None.
StartDate

date

None.
EndDate

date

None.
RestrictQty

integer

None.
SortByAscending

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "ForAllServiceProviders": true,
  "Locations": [
    1,
    2
  ],
  "StartDate": "2025-12-15T16:15:15.6529869-05:00",
  "EndDate": "2025-12-15T16:15:15.6529869-05:00",
  "RestrictQty": 1,
  "SortByAscending": true
}

application/xml, text/xml

Sample: 
<GoalsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core">
  <EndDate>2025-12-15T16:15:15.6529869-05:00</EndDate>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Locations>
  <RestrictQty>1</RestrictQty>
  <SortByAscending>true</SortByAscending>
  <StartDate>2025-12-15T16:15:15.6529869-05:00</StartDate>
  <ForAllServiceProviders>true</ForAllServiceProviders>
</GoalsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.
Content

System.Net.Http.HttpContent

None.
StatusCode

System.Net.HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

System.Net.Http.HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.