Reference for http://ws.veriscanonline.com/VSWebServices67/CustomFields
Custom Fields
Url: http://ws.veriscanonline.com/VSWebServices67/CustomFields
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<RequestModel xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common"> <AppVersion>String content</AppVersion> <CompanyId>String content</CompanyId> <ComputerName>String content</ComputerName> <HardwareId>String content</HardwareId> <IsLive>true</IsLive> <TimeZoneId>String content</TimeZoneId> <UserId>2147483647</UserId> <Login>String content</Login> <Password>String content</Password> </RequestModel>
The following is an example request Json body:
{
"AppVersion":"String content",
"CompanyId":"String content",
"ComputerName":"String content",
"HardwareId":"String content",
"IsLive":true,
"TimeZoneId":"String content",
"UserId":2147483647,
"Login":"String content",
"Password":"String content"
}
The following is an example response Xml body:
<CustomFieldsResponseModel xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.CustomFields">
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</ErrorCode>
<Status xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</Status>
<StatusCode xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">2147483647</StatusCode>
<ValidationResult xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">
<ResponseValidationResultItem>
<Errors>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</Errors>
<Field>String content</Field>
</ResponseValidationResultItem>
<ResponseValidationResultItem>
<Errors>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</Errors>
<Field>String content</Field>
</ResponseValidationResultItem>
</ValidationResult>
<CustomFieldsSettings>
<CustomFields>
<CustomField>
<Id>2147483647</Id>
<Name>String content</Name>
<Options>
<CustomFieldOption>
<Id>2147483647</Id>
<Name>String content</Name>
</CustomFieldOption>
<CustomFieldOption>
<Id>2147483647</Id>
<Name>String content</Name>
</CustomFieldOption>
</Options>
<Order>2147483647</Order>
<Required>true</Required>
<TypeId>UnknownCustomFieldType</TypeId>
</CustomField>
<CustomField>
<Id>2147483647</Id>
<Name>String content</Name>
<Options>
<CustomFieldOption>
<Id>2147483647</Id>
<Name>String content</Name>
</CustomFieldOption>
<CustomFieldOption>
<Id>2147483647</Id>
<Name>String content</Name>
</CustomFieldOption>
</Options>
<Order>2147483647</Order>
<Required>true</Required>
<TypeId>UnknownCustomFieldType</TypeId>
</CustomField>
</CustomFields>
<ShowComments>true</ShowComments>
<ShowEmail>true</ShowEmail>
<ShowPhone>true</ShowPhone>
<ShowTags>true</ShowTags>
</CustomFieldsSettings>
</CustomFieldsResponseModel>
The following is an example response Json body:
{
"ErrorCode":"String content",
"Status":"String content",
"StatusCode":2147483647,
"ValidationResult":[{
"Errors":["String content"],
"Field":"String content"
}],
"CustomFieldsSettings":{
"CustomFields":[{
"Id":2147483647,
"Name":"String content",
"Options":[{
"Id":2147483647,
"Name":"String content"
}],
"Order":2147483647,
"Required":true,
"TypeId":0
}],
"ShowComments":true,
"ShowEmail":true,
"ShowPhone":true,
"ShowTags":true
}
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="RequestModel">
<xs:complexContent mixed="false">
<xs:extension base="tns:RequestModelBase">
<xs:sequence>
<xs:element minOccurs="0" name="Login" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="RequestModel" nillable="true" type="tns:RequestModel" />
<xs:complexType name="RequestModelBase">
<xs:sequence>
<xs:element minOccurs="0" name="AppVersion" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CompanyId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ComputerName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="HardwareId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsLive" type="xs:boolean" />
<xs:element minOccurs="0" name="TimeZoneId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="UserId" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="RequestModelBase" nillable="true" type="tns:RequestModelBase" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.CustomFields" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.CustomFields" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Enums" />
<xs:complexType name="CustomFieldsResponseModel">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" base="q1:ResponseModel">
<xs:sequence>
<xs:element minOccurs="0" name="CustomFieldsSettings" nillable="true" type="tns:CustomFieldsSettingsResponseModel" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CustomFieldsResponseModel" nillable="true" type="tns:CustomFieldsResponseModel" />
<xs:complexType name="CustomFieldsSettingsResponseModel">
<xs:sequence>
<xs:element minOccurs="0" name="CustomFields" nillable="true" type="tns:ArrayOfCustomField" />
<xs:element minOccurs="0" name="ShowComments" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowEmail" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowPhone" type="xs:boolean" />
<xs:element minOccurs="0" name="ShowTags" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomFieldsSettingsResponseModel" nillable="true" type="tns:CustomFieldsSettingsResponseModel" />
<xs:complexType name="ArrayOfCustomField">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomField" nillable="true" type="tns:CustomField" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomField" nillable="true" type="tns:ArrayOfCustomField" />
<xs:complexType name="CustomField">
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Options" nillable="true" type="tns:ArrayOfCustomFieldOption" />
<xs:element minOccurs="0" name="Order" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Required" type="xs:boolean" />
<xs:element minOccurs="0" name="TypeId" xmlns:q2="http://schemas.datacontract.org/2004/07/VSWebService.Models.Enums" type="q2:CustomFieldType" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomField" nillable="true" type="tns:CustomField" />
<xs:complexType name="ArrayOfCustomFieldOption">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CustomFieldOption" nillable="true" type="tns:CustomFieldOption" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCustomFieldOption" nillable="true" type="tns:ArrayOfCustomFieldOption" />
<xs:complexType name="CustomFieldOption">
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CustomFieldOption" nillable="true" type="tns:CustomFieldOption" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:complexType name="ResponseModel">
<xs:sequence>
<xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StatusCode" type="xs:int" />
<xs:element minOccurs="0" name="ValidationResult" nillable="true" type="tns:ArrayOfResponseValidationResultItem" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseModel" nillable="true" type="tns:ResponseModel" />
<xs:complexType name="ArrayOfResponseValidationResultItem">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ResponseValidationResultItem" nillable="true" type="tns:ResponseValidationResultItem" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfResponseValidationResultItem" nillable="true" type="tns:ArrayOfResponseValidationResultItem" />
<xs:complexType name="ResponseValidationResultItem">
<xs:sequence>
<xs:element minOccurs="0" name="Errors" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
<xs:element minOccurs="0" name="Field" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseValidationResultItem" nillable="true" type="tns:ResponseValidationResultItem" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfstring">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Enums" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Enums" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="CustomFieldType">
<xs:annotation>
<xs:appinfo>
<ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="UnknownCustomFieldType" />
<xs:enumeration value="String" />
<xs:enumeration value="Number" />
<xs:enumeration value="Date" />
<xs:enumeration value="Dropdown" />
<xs:enumeration value="Checkbox" />
<xs:enumeration value="CheckboxMultiple" />
</xs:restriction>
</xs:simpleType>
<xs:element name="CustomFieldType" nillable="true" type="tns:CustomFieldType" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>