CirrusShieldWS
Click here for a complete list of operations.
describeObject
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /CirrusShieldWS.asmx HTTP/1.1 Host: ws.cirrus-shield.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://tempuri.org/describeObject" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <describeObject xmlns="http://tempuri.org/"> <objectName>string</objectName> <sessionID>string</sessionID> </describeObject> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <describeObjectResponse xmlns="http://tempuri.org/"> <describeObjectResult> <APIName>string</APIName> <Icon>string</Icon> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Label>string</Label> <PluralLabel>string</PluralLabel> <Fields> <FieldDescriptor> <Name>string</Name> <DataType>string</DataType> <Label>string</Label> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Prefix>string</Prefix> <Suffix>string</Suffix> <DisplayFormat>string</DisplayFormat> <StartingNumber>int</StartingNumber> <IsExternalID>boolean</IsExternalID> <Length>int</Length> <DecimalPlaces>int</DecimalPlaces> <IsRequired>boolean</IsRequired> <IsUnique>boolean</IsUnique> <DefaultValue>string</DefaultValue> <VisibleLinesNb>int</VisibleLinesNb> <IsCaseSensitive>boolean</IsCaseSensitive> <IsAlphabeticallySorted>boolean</IsAlphabeticallySorted> <RelatedToObject>string</RelatedToObject> <RelationshipName>string</RelationshipName> <ClrValIfLkUpDel>boolean</ClrValIfLkUpDel> <PicklistValues xsi:nil="true" /> </FieldDescriptor> <FieldDescriptor> <Name>string</Name> <DataType>string</DataType> <Label>string</Label> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Prefix>string</Prefix> <Suffix>string</Suffix> <DisplayFormat>string</DisplayFormat> <StartingNumber>int</StartingNumber> <IsExternalID>boolean</IsExternalID> <Length>int</Length> <DecimalPlaces>int</DecimalPlaces> <IsRequired>boolean</IsRequired> <IsUnique>boolean</IsUnique> <DefaultValue>string</DefaultValue> <VisibleLinesNb>int</VisibleLinesNb> <IsCaseSensitive>boolean</IsCaseSensitive> <IsAlphabeticallySorted>boolean</IsAlphabeticallySorted> <RelatedToObject>string</RelatedToObject> <RelationshipName>string</RelationshipName> <ClrValIfLkUpDel>boolean</ClrValIfLkUpDel> <PicklistValues xsi:nil="true" /> </FieldDescriptor> </Fields> </describeObjectResult> </describeObjectResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /CirrusShieldWS.asmx HTTP/1.1 Host: ws.cirrus-shield.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <describeObject xmlns="http://tempuri.org/"> <objectName>string</objectName> <sessionID>string</sessionID> </describeObject> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <describeObjectResponse xmlns="http://tempuri.org/"> <describeObjectResult> <APIName>string</APIName> <Icon>string</Icon> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Label>string</Label> <PluralLabel>string</PluralLabel> <Fields> <FieldDescriptor> <Name>string</Name> <DataType>string</DataType> <Label>string</Label> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Prefix>string</Prefix> <Suffix>string</Suffix> <DisplayFormat>string</DisplayFormat> <StartingNumber>int</StartingNumber> <IsExternalID>boolean</IsExternalID> <Length>int</Length> <DecimalPlaces>int</DecimalPlaces> <IsRequired>boolean</IsRequired> <IsUnique>boolean</IsUnique> <DefaultValue>string</DefaultValue> <VisibleLinesNb>int</VisibleLinesNb> <IsCaseSensitive>boolean</IsCaseSensitive> <IsAlphabeticallySorted>boolean</IsAlphabeticallySorted> <RelatedToObject>string</RelatedToObject> <RelationshipName>string</RelationshipName> <ClrValIfLkUpDel>boolean</ClrValIfLkUpDel> <PicklistValues xsi:nil="true" /> </FieldDescriptor> <FieldDescriptor> <Name>string</Name> <DataType>string</DataType> <Label>string</Label> <IsCustom>boolean</IsCustom> <IsEditable>boolean</IsEditable> <IsDeletable>boolean</IsDeletable> <Prefix>string</Prefix> <Suffix>string</Suffix> <DisplayFormat>string</DisplayFormat> <StartingNumber>int</StartingNumber> <IsExternalID>boolean</IsExternalID> <Length>int</Length> <DecimalPlaces>int</DecimalPlaces> <IsRequired>boolean</IsRequired> <IsUnique>boolean</IsUnique> <DefaultValue>string</DefaultValue> <VisibleLinesNb>int</VisibleLinesNb> <IsCaseSensitive>boolean</IsCaseSensitive> <IsAlphabeticallySorted>boolean</IsAlphabeticallySorted> <RelatedToObject>string</RelatedToObject> <RelationshipName>string</RelationshipName> <ClrValIfLkUpDel>boolean</ClrValIfLkUpDel> <PicklistValues xsi:nil="true" /> </FieldDescriptor> </Fields> </describeObjectResult> </describeObjectResponse> </soap12:Body> </soap12:Envelope>