POST api/Surveys/BasicDispatch

Request Information

URI Parameters

None.

Body Parameters

BasicDispatchInfo
NameDescriptionTypeAdditional information
AccessToken

string

Required

String length: inclusive between 1 and 50

FormGUID

string

Required

String length: inclusive between 1 and 50

LocationGUID

string

None.

AssetGUID

string

None.

UserGUID

string

Required

String length: inclusive between 1 and 50

Duration

string

Required

String length: inclusive between 1 and 10

Values

string

None.

ExternalID

string

None.

DispachDateTime

string

None.

ApiRef1

string

None.

ApiRef2

string

None.

ApiRef3

string

None.

ParentGUID

string

None.

ActivityGUID

string

None.

CompanyStatusGUID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AccessToken": "sample string 1",
  "FormGUID": "sample string 2",
  "LocationGUID": "sample string 3",
  "AssetGUID": "sample string 4",
  "UserGUID": "sample string 5",
  "Duration": "sample string 6",
  "Values": "sample string 7",
  "ExternalID": "sample string 8",
  "DispachDateTime": "sample string 9",
  "ApiRef1": "sample string 10",
  "ApiRef2": "sample string 11",
  "ApiRef3": "sample string 12",
  "ParentGUID": "sample string 13",
  "ActivityGUID": "sample string 14",
  "CompanyStatusGUID": "sample string 15"
}

application/octet-stream

Sample:
{"AccessToken":"sample string 1","FormGUID":"sample string 2","LocationGUID":"sample string 3","AssetGUID":"sample string 4","UserGUID":"sample string 5","Duration":"sample string 6","Values":"sample string 7","ExternalID":"sample string 8","DispachDateTime":"sample string 9","ApiRef1":"sample string 10","ApiRef2":"sample string 11","ApiRef3":"sample string 12","ParentGUID":"sample string 13","ActivityGUID":"sample string 14","CompanyStatusGUID":"sample string 15"}

application/xml, text/xml

Sample:
<BasicDispatchInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccessToken>sample string 1</AccessToken>
  <FormGUID>sample string 2</FormGUID>
  <LocationGUID>sample string 3</LocationGUID>
  <AssetGUID>sample string 4</AssetGUID>
  <UserGUID>sample string 5</UserGUID>
  <Duration>sample string 6</Duration>
  <Values>sample string 7</Values>
  <ExternalID>sample string 8</ExternalID>
  <DispachDateTime>sample string 9</DispachDateTime>
  <ApiRef1>sample string 10</ApiRef1>
  <ApiRef2>sample string 11</ApiRef2>
  <ApiRef3>sample string 12</ApiRef3>
  <ParentGUID>sample string 13</ParentGUID>
  <ActivityGUID>sample string 14</ActivityGUID>
  <CompanyStatusGUID>sample string 15</CompanyStatusGUID>
</BasicDispatchInfo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BasicDispatchInfo'.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
AcitivyGUID

string

None.

Status

string

None.

Description

string

None.

ActivityID

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AcitivyGUID": "sample string 1",
  "Status": "sample string 2",
  "Description": "sample string 3",
  "ActivityID": "sample string 4"
}

application/octet-stream

Sample:
{"AcitivyGUID":"sample string 1","Status":"sample string 2","Description":"sample string 3","ActivityID":"sample string 4"}

application/xml, text/xml

Sample:
<Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AcitivyGUID>sample string 1</AcitivyGUID>
  <Status>sample string 2</Status>
  <Description>sample string 3</Description>
  <ActivityID>sample string 4</ActivityID>
</Result>