Contacts Service API error messages

This section provides information about the error messages returned +by the Contacts Service API methods.

Generic error messages

The following table describes the error messages returned during the +loading of the service provider.

+ + + + + + + + + + + + + + + + + +

**Table:** Service provider +error messages
+ Error message +	+ Description +
+ `Contacts : Requested interface not supported by the provider` +	+ The requested interface is not supported by the service provider. +
+ `Contacts : Interface name missing` +	+ The interface name is missing from the request. +
+ `Contacts : Requested command not supported` +	+ The specified command is not supported by the interface. The name of +the command is invalid. +

The following table describes the error messages returned by asynchronous +method calls.

+ + + + + + + + + +

**Table:** Asynchronous +call error messages
+ Error message +	+ Description +
+ `Contacts : Callback not found` +	+ The `callback` method was not called. +

GetList

The following table describes the error messages returned by GetList and callback for GetList as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** GetList error +messages
+ Error message +	+ Description +
+ `Contacts : GetList : Type is Missing` +	+ The `Type` property is missing from input. +
+ `Contacts : GetList : Invalid value for Type, Must be Contact/Group/Database` +	+ The `Type` property contains an invalid value. +
+ `Contacts : GetList : Invalid Sort Type, Object is required` +	+ The `Sort` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : GetList : Sort Order Value is not a String` +	+ The `Sort.Order` property contains a value with an +invalid type. A string is expected. +
+ `Contacts : GetList : Invalid Type of Filter, Object is required` +	+ The `Filter` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : GetList : Wrong Type of Sort Order value` +	+ The `Sort.Order` property contains an invalid value. +The value must be `"Ascending"` or `"Descending"`. +
+ `Contacts : GetList : Wrong Type of Search value` +	+ The `SearchVal` property contains a value with an +invalid type. A string is expected. +
+ `Contacts : GetList : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +

Add

The following table describes the error messages returned by Add and callback for Add as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** Add error messages
+ Error message +	+ Description +
+ `Contacts : Add : Type is Missing` +	+ The `Type` property is missing from the input. +
+ `Contacts : Add : Invalid Type, must be Contact/Group` +	+ The `Type` property contains an invalid value. The +value must be `"Contact"` or `"Group"`. +
+ `Contacts : Add : Add Data is Missing` +	+ The `Data` property is missing from the input. +
+ `Contacts : Add : Add data Object is Missing` +	+ The `Data` property does not contain a value. +
+ `Contacts : Add : Group Label is Missing` +	+ The `Data.GroupLabel` property is missing from the +input. +
+ `Contacts : Add : Mandatory Argument is not present` +	+ Some mandatory parameters are missing from the input. +
+ `Contacts : Add : Type of Contact Id is wrong` +	+ The `Data.id` property for the contact contains a +value with an invalid type. A string is expected. +
+ `Contacts : Add : Invalid Type of Data, Object is required` +	+ The `Data` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : Add : Invalid Type of Field value, Object is required` +	+ A `<key>.Value` property contains a value with +an invalid type. An object is expected. +
+ `Contacts : Add : Invalid Type of NextField value, Object is +required` +	+ A `<key>.Next` property contains a value with +an invalid type. An object is expected. +
+ `Contacts : Add : Invalid Type of Id` +	+ The `Data.id` property for the contact group contains +a value with an invalid type. A string is expected. +
+ `Contacts : Add : Invalid Type of GroupLabel` +	+ The `Data.GroupLabel` property contains a value with +an invalid type. A string is expected. +
+ `Contacts : Add : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Add : At least one field is required` +	+ At least one key (`Data.<key>`) must be specified. +
+ `Contacts : Add : Group Label is Empty` +	+ The mandatory `Data.GroupLabel` property is an empty +string. +
+ `Contacts : Add : Invalid Field Key : <key>` +	+ The key (`Data.<key>`) is not a valid. +
+ `Contacts : Add : Field Key Not Supported on this Database: +<key>` +	+ The key (`Data.<key>`) is not supported on the +given database. +
+ `Contacts : Add : Field Value too long for key : <key>` +	+ The key (`Data.<key>`) has a length greater than +the maximum length allowed for that key. +

Delete

The following table describes the error messages returned by Delete and callback for Delete as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** Delete error +messages
+ Error message +	+ Description +
+ `Contacts : Delete : Type is Missing` +	+ The `Type` property is missing from the input. +
+ `Contacts : Delete : Invalid Type, must be Contact/Group` +	+ The `Type` property contains an invalid value. The +value must be `"Contact"` or `"Group"`. +
+ `Contacts : Delete : Delete data Missing` +	+ The `Data` property is missing from the input. +
+ `Contacts : Delete : Invalid Type of Data , Object is required` +	+ The `Data` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : Delete : List of Ids is missing` +	+ The list of IDs indicating the contacts or contact groups to be deleted +(`Data.IdList`) is missing from the input. +
+ `Contacts : Delete : Type of IdList is wrong, List is required` +	+ The `Data.IdList` property contains a value with +an invalid type. An array is expected. +
+ `Contacts : Delete : Invalid Type of Id` +	+ The `Data.id` property for the contact or contact +group contains a value with an invalid type. A string is expected. +
+ `Contacts : Delete : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Delete : Mandatory Argument is not present` +	+ Some mandatory parameters are missing from the input. +

Import

The following table describes the error messages returned by Import and callback for Import as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** Import error +messages
+ Error message +	+ Description +
+ `Contacts : Import : Type is Missing` +	+ The `Type` property is missing from the input. +
+ `Contacts : Import : Invalid Type,it must be Contact` +	+ The `Type` property contains an invalid value. The +value must be `"Contact"`. +
+ `Contacts : Import : Import data Missing` +	+ The `Data` property is missing from the input. +
+ `Contacts : Import : Invalid Type of Data , Object is required` +	+ The `Data` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : Import : Import Source Filename is Missing` +	+ The `Data.SourceFile` property is missing from the +input. +
+ `Contacts : Import : Import Source File is not a String` +	+ The `Data.SourceFile` property contains a value with +an invalid type. A string is expected. +
+ `Contacts : Import : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Import : Mandatory Argument is not present` +	+ Some mandatory parameters are missing from the input. +
+ `Contacts : Import : Import DataBaseUri is not a String` +	+ The `Data.DBUri` property contains a value with an +invalid type. A string is expected. +
+ `Contacts : Import : Filename too long` +	+ The value of the `Data.SourceFile` property exceeds +256 characters. +

Export

The following table describes the error messages returned by Export and callback for Export as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** Export error +messages
+ Error message +	+ Description +
+ `Contacts : Export : Type is Missing` +	+ The `Type` property is missing from the input. +
+ `Contacts : Export : Invalid Type, it must be Contact` +	+ The `Type` property contains an invalid value. The +value must be `"Contact"`. +
+ `Contacts : Export : Export Data Missing` +	+ The `Data` property is missing from the input. +
+ `Contacts : Export : Invalid Type of Data , Object is required` +	+ The `Data` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : Export : Export Destination Filename is Missing` +	+ The `Data.DestinationFile` property is missing from +the input. +
+ `Contacts : Export : Contact Id to be exported is missing.` +	+ The `Data.id` property is missing from the input. +
+ `Contacts : Export : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Export : Destination Filename is of wrong Type` +	+ The `Data.DestinationFile` property contains a value +with an invalid type. A string is expected. +
+ `Contacts : Export : Id is of wrong Type` +	+ The `Data.id` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Export : Mandatory Argument is not present` +	+ Some mandatory parameters are missing from the input. +
+ `Contacts : Export : Export DataBaseUri is not a String` +	+ The `Data.DBUri` property contains a value with an +invalid type. A string is expected. +
+ `Contacts : Export : Filename too long` +	+ The value of the `Data.DestinationFile` property +exceeds 256 characters. +

Organise

The following table describes the error messages returned by Organise and callback for Organise as +part of their return value.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

**Table:** Organise error +messages
+ Error message +	+ Description +
+ `Contacts : Organise : Type is Missing` +	+ The `Type` property is missing from the input. +
+ `Contacts : Organise : Invalid Content Type, It must be Group` +	+ The `Type` property contains an invalid value. The +value must be `"Group"`. +
+ `Contacts : Organise : Organise Data is Missing` +	+ The `Data` property is missing from the input. +
+ `Contacts : Organise : Invalid Type of Data , Object is required` +	+ The `Data` property contains a value with an invalid +type. An object is expected. +
+ `Contacts : Organise : List of Ids is missing` +	+ The list of contact IDs (`Data.IdList`) is missing +from the input. +
+ `Contacts : Organise : Id is missing` +	+ The contact group ID (`Data.id`) is missing from +the input. +
+ `Contacts : Organise : OperationType is Missing` +	+ The `OperationType` property is missing from the +input. +
+ `Contacts : Organise : Operation Type is Wrong` +	+ The `OperationType` property contains a value with +an invalid type. A string is expected. +
+ `Contacts : Organise : Invalid Operation Type` +	+ The `OperationType` property contains an invalid +value. The value must be `"Associate"` or `"Disassociate"`. +
+ `Contacts : Organise : Id type is wrong` +	+ The `Data.id` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Organise : IdList type is wrong` +	+ The `Data.IdList` property contains a value with +an invalid type. An array is expected. +
+ `Contacts : Organise : Wrong Type of ContentType` +	+ The `Type` property contains a value with an invalid +type. A string is expected. +
+ `Contacts : Organise : Mandatory Argument is not present` +	+ Some mandatory parameters are missing from the input. +
+ `Contacts : Organise : Id List is empty` +	+ The `Data.IdList` array contains no items. +

Cancel

The following table describes the error messages returned by Cancel as part of its return value.

+ + + + + + + + + + + + + +

**Table:** Cancel error +messages
+ Error message +	+ Description +
+ `Contacts : Cancel : Cancel Unsuccessful` +	+ The `Cancel` call was unsuccessful. Check the error code. +
+ `Contacts : Cancel : Transaction ID is Missing` +	+ The `TransactionID` property is missing from the +input. +