GET api/BCHDutiesExport?apiKey={apiKey}&idnumber={idnumber}&forceID={forceID}&daysAhead={daysAhead}&workingDutiesOnly={workingDutiesOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required

idnumber

string

Required

forceID

string

Required

daysAhead

integer

Required

workingDutiesOnly

boolean

Required

Body Parameters

None.

Response Information

Resource Description

basicReturnType
NameDescriptionTypeAdditional information
success

boolean

None.

rid

integer

None.

datasetResults

DataSet

None.

datatableResults

DataTable

None.

objectResult

Object

None.

resultAction

basicReturnTypeResultAction

None.

booleanResult

boolean

None.

Output_Parameter_rid

integer

None.

ErrorMessage

string

None.

ErrorMessageType

basicReturnTypeErrorEnum

None.

ErrorProcedure

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "rid": 2,
  "datasetResults": null,
  "datatableResults": null,
  "objectResult": {},
  "resultAction": 0,
  "booleanResult": true,
  "Output_Parameter_rid": 5,
  "ErrorMessage": "sample string 6",
  "ErrorMessageType": 0,
  "ErrorProcedure": ""
}

application/xml, text/xml

Sample:
<basicReturnType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GRSDBFunctions">
  <ErrorMessage>sample string 6</ErrorMessage>
  <ErrorMessageType>None</ErrorMessageType>
  <Output_Parameter_rid>5</Output_Parameter_rid>
  <booleanResult>true</booleanResult>
  <datasetResults i:nil="true" />
  <datatableResults i:nil="true" />
  <objectResult />
  <resultAction>None</resultAction>
  <rid>2</rid>
  <success>true</success>
</basicReturnType>