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": "a331cdef-c95e-45bb-8099-46b6e014572c", "text": "sample string 1", "value": "sample string 2", "insuredDatabaseId": "bd1f8baa-f93f-4200-ac04-dad7a9b16f5d", "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>a331cdef-c95e-45bb-8099-46b6e014572c</DatabaseId> <InsuredCommercialName>sample string 6</InsuredCommercialName> <InsuredDatabaseId>bd1f8baa-f93f-4200-ac04-dad7a9b16f5d</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": "59fff1ce-f356-41df-ab44-439275187f96", "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>59fff1ce-f356-41df-ab44-439275187f96</DatabaseId> </NowCertsApiResultWithDatabaseId>