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.
SimpleCustomFieldRecordName | Description | Type | Additional 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": "f2dd2886-55e1-4b48-85b2-aa10af53ef2a", "text": "sample string 1", "value": "sample string 2", "insuredDatabaseId": "7dbde404-1b2d-4837-ad4a-1958d93e4f58", "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>f2dd2886-55e1-4b48-85b2-aa10af53ef2a</DatabaseId> <InsuredCommercialName>sample string 6</InsuredCommercialName> <InsuredDatabaseId>7dbde404-1b2d-4837-ad4a-1958d93e4f58</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.
NowCertsApiResultWithDatabaseIdName | Description | Type | Additional information |
---|---|---|---|
DatabaseId | globally unique identifier |
None. |
|
Status | ApiStatus |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "databaseId": "57078a46-6654-46ef-a56c-9fd30b060c11", "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>57078a46-6654-46ef-a56c-9fd30b060c11</DatabaseId> </NowCertsApiResultWithDatabaseId>