Reference for https://epona.centerbase.com/Mobile/api.svc/json/netdocuments/sync/apply
Url: https://epona.centerbase.com/Mobile/api.svc/json/netdocuments/sync/apply
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:
<CBAPINetDocsSyncApplyRequest xmlns="www.Centerbase.com">
<createIfMissing>true</createIfMissing>
<entity>
<id>String content</id>
<match>
<clientNumber>String content</clientNumber>
<matterNumber>String content</matterNumber>
</match>
<type>String content</type>
</entity>
<fields>
<CBAPINetDocsSyncField>
<fieldId>String content</fieldId>
<lookupMatch>
<itemType>2147483647</itemType>
<objectType>2147483647</objectType>
</lookupMatch>
<strategy>String content</strategy>
<value>String content</value>
</CBAPINetDocsSyncField>
<CBAPINetDocsSyncField>
<fieldId>String content</fieldId>
<lookupMatch>
<itemType>2147483647</itemType>
<objectType>2147483647</objectType>
</lookupMatch>
<strategy>String content</strategy>
<value>String content</value>
</CBAPINetDocsSyncField>
</fields>
<runId>String content</runId>
<sourceApp>String content</sourceApp>
<syncedAt>String content</syncedAt>
</CBAPINetDocsSyncApplyRequest>
The following is an example request Json body:
{
"createIfMissing":true,
"entity":{
"id":"String content",
"match":{
"clientNumber":"String content",
"matterNumber":"String content"
},
"type":"String content"
},
"fields":[{
"fieldId":"String content",
"lookupMatch":{
"itemType":2147483647,
"objectType":2147483647
},
"strategy":"String content",
"value":"String content"
}],
"runId":"String content",
"sourceApp":"String content",
"syncedAt":"String content"
}
The following is an example response Xml body:
<CBAPINetDocsSyncApplyResponse xmlns="www.Centerbase.com">
<error-code>2147483647</error-code>
<error-message>String content</error-message>
<entityId>String content</entityId>
<entityLabel>String content</entityLabel>
<matched>true</matched>
<results>
<CBAPINetDocsSyncFieldResult>
<action>String content</action>
<fieldId>String content</fieldId>
<message>String content</message>
<newValue>String content</newValue>
<previousValue>String content</previousValue>
</CBAPINetDocsSyncFieldResult>
<CBAPINetDocsSyncFieldResult>
<action>String content</action>
<fieldId>String content</fieldId>
<message>String content</message>
<newValue>String content</newValue>
<previousValue>String content</previousValue>
</CBAPINetDocsSyncFieldResult>
</results>
</CBAPINetDocsSyncApplyResponse>
The following is an example response Json body:
{
"error-code":2147483647,
"error-message":"String content",
"entityId":"String content",
"entityLabel":"String content",
"matched":true,
"results":[{
"action":"String content",
"fieldId":"String content",
"message":"String content",
"newValue":"String content",
"previousValue":"String content"
}]
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="www.Centerbase.com" elementFormDefault="qualified" targetNamespace="www.Centerbase.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="CBAPINetDocsSyncApplyRequest">
<xs:sequence>
<xs:element minOccurs="0" name="createIfMissing" type="xs:boolean" />
<xs:element minOccurs="0" name="entity" nillable="true" type="tns:CBAPINetDocsSyncEntity" />
<xs:element minOccurs="0" name="fields" nillable="true" type="tns:ArrayOfCBAPINetDocsSyncField" />
<xs:element minOccurs="0" name="runId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="sourceApp" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="syncedAt" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncApplyRequest" nillable="true" type="tns:CBAPINetDocsSyncApplyRequest" />
<xs:complexType name="CBAPINetDocsSyncEntity">
<xs:sequence>
<xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="match" nillable="true" type="tns:CBAPINetDocsSyncEntityMatch" />
<xs:element minOccurs="0" name="type" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncEntity" nillable="true" type="tns:CBAPINetDocsSyncEntity" />
<xs:complexType name="CBAPINetDocsSyncEntityMatch">
<xs:sequence>
<xs:element minOccurs="0" name="clientNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="matterNumber" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncEntityMatch" nillable="true" type="tns:CBAPINetDocsSyncEntityMatch" />
<xs:complexType name="ArrayOfCBAPINetDocsSyncField">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CBAPINetDocsSyncField" nillable="true" type="tns:CBAPINetDocsSyncField" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCBAPINetDocsSyncField" nillable="true" type="tns:ArrayOfCBAPINetDocsSyncField" />
<xs:complexType name="CBAPINetDocsSyncField">
<xs:sequence>
<xs:element minOccurs="0" name="fieldId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="lookupMatch" nillable="true" type="tns:CBAPINetDocsSyncLookupMatch" />
<xs:element minOccurs="0" name="strategy" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncField" nillable="true" type="tns:CBAPINetDocsSyncField" />
<xs:complexType name="CBAPINetDocsSyncLookupMatch">
<xs:sequence>
<xs:element minOccurs="0" name="itemType" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="objectType" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncLookupMatch" nillable="true" type="tns:CBAPINetDocsSyncLookupMatch" />
</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>
<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="schema">
<xs:complexType />
</xs:element>
</xs:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="www.Centerbase.com" elementFormDefault="qualified" targetNamespace="www.Centerbase.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="CBAPINetDocsSyncApplyResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:CBAPIResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="entityId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="entityLabel" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="matched" type="xs:boolean" />
<xs:element minOccurs="0" name="results" nillable="true" type="tns:ArrayOfCBAPINetDocsSyncFieldResult" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncApplyResponse" nillable="true" type="tns:CBAPINetDocsSyncApplyResponse" />
<xs:complexType name="CBAPIResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="error-code" type="xs:int" />
<xs:element minOccurs="0" name="error-message" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPIResponseBase" nillable="true" type="tns:CBAPIResponseBase" />
<xs:complexType name="ArrayOfCBAPINetDocsSyncFieldResult">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="CBAPINetDocsSyncFieldResult" nillable="true" type="tns:CBAPINetDocsSyncFieldResult" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCBAPINetDocsSyncFieldResult" nillable="true" type="tns:ArrayOfCBAPINetDocsSyncFieldResult" />
<xs:complexType name="CBAPINetDocsSyncFieldResult">
<xs:sequence>
<xs:element minOccurs="0" name="action" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="fieldId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="message" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="newValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="previousValue" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="CBAPINetDocsSyncFieldResult" nillable="true" type="tns:CBAPINetDocsSyncFieldResult" />
</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 targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="schema">
<xs:complexType />
</xs:element>
</xs:schema>