GetFieldIdByGUID

The GetFieldIDByGUID method returns the Field ID of the field associated with the specified GUID.

On this page

Usage

Privileges. This method requires Read privileges.

Parameters.

The parameters for the GetFieldIDByGUID method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method.
GUID	String	GUID for the desired field. Note: This value can be found by reviewing the Application Field Detail report within the Archer Platform and copying the GUID for the desired field.
valuesListValueId	Integer	Internal ID of the specific values list value you want to delete as returned by the field.LookupListValue method.

Output. This method returns an integer. If the method was successful, the value is the ID of the field associated with the GUID. If there is a failure, the API issues an exception.

Samples

Sample C# Call

iReturnCode = field.GetFieldIdByGUID(sSessionToken,
“7538F922-7794-11E2-BCD8-634F61887098”);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/field.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/GetFieldIdByGUID"

<?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>

<sessionToken>string</sessionToken>

<GUID>string</GUID>

</GetFieldIdByGUID>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK