Reference for https://buildcont.tpcx.com:17143/uiserver0/api/v2/basics/{NAME}
Get the basics for a given service -- only required edits
Url: https://buildcont.tpcx.com:17143/uiserver0/api/v2/basics/{NAME}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<Transaction xmlns="http://schemas.datacontract.org/2004/07/P21.Transactions.Model.V2"> <DataElements> <DataElement> <BusinessObjectName>String content</BusinessObjectName> <Keys> <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> </Keys> <Name>String content</Name> <Rows> <Row> <Edits> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> </Edits> <RelativeDateEdits> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> </RelativeDateEdits> </Row> <Row> <Edits> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> </Edits> <RelativeDateEdits> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> </RelativeDateEdits> </Row> </Rows> <Type>Form</Type> </DataElement> <DataElement> <BusinessObjectName>String content</BusinessObjectName> <Keys> <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> </Keys> <Name>String content</Name> <Rows> <Row> <Edits> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> </Edits> <RelativeDateEdits> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> </RelativeDateEdits> </Row> <Row> <Edits> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> <Edit> <IgnoreIfEmpty>true</IgnoreIfEmpty> <Name>String content</Name> <Value>String content</Value> </Edit> </Edits> <RelativeDateEdits> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> <DateEdit> <Name>String content</Name> <Value> <DayOfMonth> <Value>String content</Value> </DayOfMonth> <DayOffsetValue>String content</DayOffsetValue> <MonthOffsetValue>String content</MonthOffsetValue> <OverrideDate>true</OverrideDate> <TimeOfDay> <Value>String content</Value> </TimeOfDay> </Value> </DateEdit> </RelativeDateEdits> </Row> </Rows> <Type>Form</Type> </DataElement> </DataElements> <Documents> <Document xmlns=""> <Batch> <BatchId>String content</BatchId> <BatchSequence>2147483647</BatchSequence> </Batch> <ClientId>String content</ClientId> <DocumentAssociations> <DocumentAssociation> <AssociationType>LinkedDocument</AssociationType> <DocumentId>String content</DocumentId> <Name>String content</Name> <Uri>String content</Uri> </DocumentAssociation> <DocumentAssociation> <AssociationType>LinkedDocument</AssociationType> <DocumentId>String content</DocumentId> <Name>String content</Name> <Uri>String content</Uri> </DocumentAssociation> </DocumentAssociations> <DocumentContentType>String content</DocumentContentType> <DocumentData>QmFzZSA2NCBTdHJlYW0=</DocumentData> <DocumentFormat>CrystalReport</DocumentFormat> <DocumentId>String content</DocumentId> <DocumentName>String content</DocumentName> <DocumentType>Unspecified</DocumentType> <FileName>String content</FileName> <RequestId>String content</RequestId> <ResponseStatus> <Message>String content</Message> <StackTrace>String content</StackTrace> <StatusCode>String content</StatusCode> </ResponseStatus> </Document> <Document xmlns=""> <Batch> <BatchId>String content</BatchId> <BatchSequence>2147483647</BatchSequence> </Batch> <ClientId>String content</ClientId> <DocumentAssociations> <DocumentAssociation> <AssociationType>LinkedDocument</AssociationType> <DocumentId>String content</DocumentId> <Name>String content</Name> <Uri>String content</Uri> </DocumentAssociation> <DocumentAssociation> <AssociationType>LinkedDocument</AssociationType> <DocumentId>String content</DocumentId> <Name>String content</Name> <Uri>String content</Uri> </DocumentAssociation> </DocumentAssociations> <DocumentContentType>String content</DocumentContentType> <DocumentData>QmFzZSA2NCBTdHJlYW0=</DocumentData> <DocumentFormat>CrystalReport</DocumentFormat> <DocumentId>String content</DocumentId> <DocumentName>String content</DocumentName> <DocumentType>Unspecified</DocumentType> <FileName>String content</FileName> <RequestId>String content</RequestId> <ResponseStatus> <Message>String content</Message> <StackTrace>String content</StackTrace> <StatusCode>String content</StatusCode> </ResponseStatus> </Document> </Documents> <Status>New</Status> </Transaction>
The following is an example response Json body:
{ "DataElements":[{ "BusinessObjectName":"String content", "Keys":["String content"], "Name":"String content", "Rows":[{ "Edits":[{ "IgnoreIfEmpty":true, "Name":"String content", "Value":"String content" }], "RelativeDateEdits":[{ "Name":"String content", "Value":{ "DayOfMonth":{ "Value":"String content" }, "DayOffsetValue":"String content", "MonthOffsetValue":"String content", "OverrideDate":true, "TimeOfDay":{ "Value":"String content" } } }] }], "Type":0 }], "Documents":[{ "Batch":{ "BatchId":"String content", "BatchSequence":2147483647 }, "ClientId":"String content", "DocumentAssociations":[{ "AssociationType":0, "DocumentId":"String content", "Name":"String content", "Uri":"String content" }], "DocumentContentType":"String content", "DocumentData":[81, 109, 70, 122, 90, 83, 65, 50, 78, 67, 66, 84, 100, 72, 74, 108, 89, 87, 48, 61], "DocumentFormat":0, "DocumentId":"String content", "DocumentName":"String content", "DocumentType":0, "FileName":"String content", "RequestId":"String content", "ResponseStatus":{ "Message":"String content", "StackTrace":"String content", "StatusCode":"String content" } }], "Status":0 }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/P21.Transactions.Model.V2" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/P21.Transactions.Model.V2" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import /> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="Transaction"> <xs:sequence> <xs:element minOccurs="0" name="DataElements" nillable="true" type="tns:ArrayOfDataElement" /> <xs:element minOccurs="0" name="Documents" nillable="true" type="ArrayOfDocument" /> <xs:element minOccurs="0" name="Status" type="tns:TransactionStatus" /> </xs:sequence> </xs:complexType> <xs:element name="Transaction" nillable="true" type="tns:Transaction" /> <xs:complexType name="ArrayOfDataElement"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DataElement" nillable="true" type="tns:DataElement" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDataElement" nillable="true" type="tns:ArrayOfDataElement" /> <xs:complexType name="DataElement"> <xs:sequence> <xs:element minOccurs="0" name="BusinessObjectName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Keys" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Rows" nillable="true" type="tns:ArrayOfRow" /> <xs:element minOccurs="0" name="Type" type="tns:DataElementType" /> </xs:sequence> </xs:complexType> <xs:element name="DataElement" nillable="true" type="tns:DataElement" /> <xs:complexType name="ArrayOfRow"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Row" nillable="true" type="tns:Row" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfRow" nillable="true" type="tns:ArrayOfRow" /> <xs:complexType name="Row"> <xs:sequence> <xs:element minOccurs="0" name="Edits" nillable="true" type="tns:ArrayOfEdit" /> <xs:element minOccurs="0" name="RelativeDateEdits" nillable="true" type="tns:ArrayOfDateEdit" /> </xs:sequence> </xs:complexType> <xs:element name="Row" nillable="true" type="tns:Row" /> <xs:complexType name="ArrayOfEdit"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Edit" nillable="true" type="tns:Edit" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfEdit" nillable="true" type="tns:ArrayOfEdit" /> <xs:complexType name="Edit"> <xs:sequence> <xs:element minOccurs="0" name="IgnoreIfEmpty" type="xs:boolean" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Edit" nillable="true" type="tns:Edit" /> <xs:complexType name="ArrayOfDateEdit"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DateEdit" nillable="true" type="tns:DateEdit" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDateEdit" nillable="true" type="tns:ArrayOfDateEdit" /> <xs:complexType name="DateEdit"> <xs:sequence> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Value" nillable="true" type="tns:DynamicDate" /> </xs:sequence> </xs:complexType> <xs:element name="DateEdit" nillable="true" type="tns:DateEdit" /> <xs:complexType name="DynamicDate"> <xs:sequence> <xs:element minOccurs="0" name="DayOfMonth" nillable="true" type="tns:DynamicDateCode" /> <xs:element minOccurs="0" name="DayOffsetValue" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MonthOffsetValue" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="OverrideDate" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="TimeOfDay" nillable="true" type="tns:DynamicDateCode" /> </xs:sequence> </xs:complexType> <xs:element name="DynamicDate" nillable="true" type="tns:DynamicDate" /> <xs:complexType name="DynamicDateCode"> <xs:sequence> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DynamicDateCode" nillable="true" type="tns:DynamicDateCode" /> <xs:simpleType name="DataElementType"> <xs:restriction base="xs:string"> <xs:enumeration value="Form" /> <xs:enumeration value="List" /> <xs:enumeration value="Other" /> </xs:restriction> </xs:simpleType> <xs:element name="DataElementType" nillable="true" type="tns:DataElementType" /> <xs:simpleType name="TransactionStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="New" /> <xs:enumeration value="Failed" /> <xs:enumeration value="Passed" /> </xs:restriction> </xs:simpleType> <xs:element name="TransactionStatus" nillable="true" type="tns:TransactionStatus" /> </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.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 elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ArrayOfDocument"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Document" nillable="true" type="Document" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDocument" nillable="true" type="ArrayOfDocument" /> <xs:complexType name="Document"> <xs:sequence> <xs:element minOccurs="0" name="Batch" nillable="true" type="DocumentBatch" /> <xs:element minOccurs="0" name="ClientId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DocumentAssociations" nillable="true" type="ArrayOfDocumentAssociation" /> <xs:element minOccurs="0" name="DocumentContentType" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DocumentData" nillable="true" type="xs:base64Binary" /> <xs:element minOccurs="0" name="DocumentFormat" type="DocumentFormat" /> <xs:element minOccurs="0" name="DocumentId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DocumentName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DocumentType" type="DocumentType" /> <xs:element minOccurs="0" name="FileName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="RequestId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ResponseStatus" nillable="true" type="ResponseStatus" /> </xs:sequence> </xs:complexType> <xs:element name="Document" nillable="true" type="Document" /> <xs:complexType name="DocumentBatch"> <xs:sequence> <xs:element minOccurs="0" name="BatchId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="BatchSequence" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="DocumentBatch" nillable="true" type="DocumentBatch" /> <xs:complexType name="ArrayOfDocumentAssociation"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DocumentAssociation" nillable="true" type="DocumentAssociation" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDocumentAssociation" nillable="true" type="ArrayOfDocumentAssociation" /> <xs:complexType name="DocumentAssociation"> <xs:sequence> <xs:element minOccurs="0" name="AssociationType" type="DocumentAssociationType" /> <xs:element name="DocumentId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Uri" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DocumentAssociation" nillable="true" type="DocumentAssociation" /> <xs:simpleType name="DocumentAssociationType"> <xs:restriction base="xs:string"> <xs:enumeration value="LinkedDocument" /> </xs:restriction> </xs:simpleType> <xs:element name="DocumentAssociationType" nillable="true" type="DocumentAssociationType" /> <xs:simpleType name="DocumentFormat"> <xs:restriction base="xs:string"> <xs:enumeration value="CrystalReport"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Word"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="PDF"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Excel"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">15</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Xml"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">13</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="DocumentFormat" nillable="true" type="DocumentFormat" /> <xs:simpleType name="DocumentType"> <xs:restriction base="xs:string"> <xs:enumeration value="Unspecified" /> <xs:enumeration value="Form" /> <xs:enumeration value="Report" /> </xs:restriction> </xs:simpleType> <xs:element name="DocumentType" nillable="true" type="DocumentType" /> <xs:complexType name="ResponseStatus"> <xs:sequence> <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StackTrace" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StatusCode" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ResponseStatus" nillable="true" type="ResponseStatus" /> </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>