POST api/Fault

Request Information

URI Parameters

None.

Body Parameters

Fault
NameDescriptionTypeAdditional information
title

string

None.

description

string

None.

imageString

string

None.

latitude

string

None.

longitude

string

None.

crmAccountId

string

Required

deviceId

string

Required

date

string

None.

time

string

None.

isCurrentLocation

boolean

None.

faultId

string

None.

comments

string

None.

rating

integer

None.

satisfied

boolean

None.

faultRefNo

string

None.

status

string

None.

updateText

string

None.

category

Category

None.

division

Division

None.

Request Formats

application/json, text/json

Sample:
{
  "title": "sample string 1",
  "description": "sample string 2",
  "imageString": "sample string 3",
  "latitude": "sample string 4",
  "longitude": "sample string 5",
  "crmAccountId": "sample string 6",
  "deviceId": "sample string 7",
  "date": "sample string 8",
  "time": "sample string 9",
  "isCurrentLocation": true,
  "faultId": "sample string 11",
  "comments": "sample string 12",
  "rating": 13,
  "satisfied": true,
  "faultRefNo": "sample string 15",
  "status": "sample string 16",
  "updateText": "sample string 17",
  "category": {
    "name": "sample string 1",
    "categoryId": "f1084bdf-68c2-47e8-82dc-dd2f91171b1f"
  },
  "division": {
    "name": "sample string 1",
    "divisionId": "d3319ab9-4b7a-49e5-82a8-849ec3a653bc",
    "Categories": [
      {
        "name": "sample string 1",
        "categoryId": "f1084bdf-68c2-47e8-82dc-dd2f91171b1f"
      },
      {
        "name": "sample string 1",
        "categoryId": "f1084bdf-68c2-47e8-82dc-dd2f91171b1f"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<Fault xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConnectAPI.Models">
  <category>
    <categoryId>f1084bdf-68c2-47e8-82dc-dd2f91171b1f</categoryId>
    <name>sample string 1</name>
  </category>
  <comments>sample string 12</comments>
  <crmAccountId>sample string 6</crmAccountId>
  <date>sample string 8</date>
  <description>sample string 2</description>
  <deviceId>sample string 7</deviceId>
  <division>
    <Categories>
      <Category>
        <categoryId>f1084bdf-68c2-47e8-82dc-dd2f91171b1f</categoryId>
        <name>sample string 1</name>
      </Category>
      <Category>
        <categoryId>f1084bdf-68c2-47e8-82dc-dd2f91171b1f</categoryId>
        <name>sample string 1</name>
      </Category>
    </Categories>
    <divisionId>d3319ab9-4b7a-49e5-82a8-849ec3a653bc</divisionId>
    <name>sample string 1</name>
  </division>
  <faultId>sample string 11</faultId>
  <faultRefNo>sample string 15</faultRefNo>
  <imageString>sample string 3</imageString>
  <isCurrentLocation>true</isCurrentLocation>
  <latitude>sample string 4</latitude>
  <longitude>sample string 5</longitude>
  <rating>13</rating>
  <satisfied>true</satisfied>
  <status>sample string 16</status>
  <time>sample string 9</time>
  <title>sample string 1</title>
  <updateText>sample string 17</updateText>
</Fault>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FaultReportedMessage
NameDescriptionTypeAdditional information
faultRefNo

string

None.

faultId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "faultRefNo": "sample string 1",
  "faultId": "7b711261-d2b5-4141-86f0-25bb87a7dc75"
}

application/xml, text/xml

Sample:
<FaultReportedMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConnectAPI.Models">
  <faultId>7b711261-d2b5-4141-86f0-25bb87a7dc75</faultId>
  <faultRefNo>sample string 1</faultRefNo>
</FaultReportedMessage>