POST api/SimpleCustomField/Insert

Inserts or updates a simple custom field for a trucking company.

Request Information

URI Parameters

None.

Body Parameters

The custom field data.

SimpleCustomFieldRecord
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Text

string

None.

Value

string

None.

InsuredDatabaseId

globally unique identifier

None.

InsuredEmail

string

None.

InsuredFirstName

string

None.

InsuredLastName

string

None.

InsuredCommercialName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "databaseId": "154a7ede-ef17-4ba4-895c-a9210536bb76",
  "text": "sample string 1",
  "value": "sample string 2",
  "insuredDatabaseId": "72dd7bd8-0861-4c79-a263-9ce5f26ea2da",
  "insuredEmail": "sample string 3",
  "insuredFirstName": "sample string 4",
  "insuredLastName": "sample string 5",
  "insuredCommercialName": "sample string 6"
}

application/xml, text/xml

Sample:
<SimpleCustomFieldRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <DatabaseId>154a7ede-ef17-4ba4-895c-a9210536bb76</DatabaseId>
  <InsuredCommercialName>sample string 6</InsuredCommercialName>
  <InsuredDatabaseId>72dd7bd8-0861-4c79-a263-9ce5f26ea2da</InsuredDatabaseId>
  <InsuredEmail>sample string 3</InsuredEmail>
  <InsuredFirstName>sample string 4</InsuredFirstName>
  <InsuredLastName>sample string 5</InsuredLastName>
  <Text>sample string 1</Text>
  <Value>sample string 2</Value>
</SimpleCustomFieldRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

API result with the database ID of the operation.

NowCertsApiResultWithDatabaseId
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Status

ApiStatus

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "a9fb116a-656b-441c-a2ed-ce8ddd2184b0",
  "status": 0,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<NowCertsApiResultWithDatabaseId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Message>sample string 2</Message>
  <Status>Error</Status>
  <DatabaseId>a9fb116a-656b-441c-a2ed-ce8ddd2184b0</DatabaseId>
</NowCertsApiResultWithDatabaseId>