Previous Topic: External Agent Socket API Request MessageNext Topic: Object Types


External Agent Socket API Request Data Header

The External Agent Socket API Request Data Header is at the beginning of the data packet.

Bytes

Field Name

Type

Description

Mandatory?

1 – 4

Object Type

UINT4
Big-endian

A member of the enumeration: WGN_OBJECT_TYPE.

Yes

5 – 8

Object Format

UINT4
Big-endian

A member of the enumeration: WGN_OBJECT_FORMAT.

Yes

9 – 12

Object Transport

UINT4
Big-endian.

A member of the enumeration: WGN_OBJECT_TRANSPORT.

Yes

13 – 14

Request Flags

UINT2
Big-endian.

Enable Deferred Completion 0x0001

Yes

15 – 16

Response Flags

UINT2
Big-endian.

Return XML 0x0001

Yes

17 – 20

XML Results Flags

UINT4
Big-endian.

Selects XML Results that will be returned in the response. Zero indicates return the default data elements.

No

21 – 24

Element Count

UINT4
Big-endian

Number of Data Elements.

Yes

25 – 28

Reserved 1

UINT4
Big-endian.

Must be zeros.

Yes

29 – 32

Reserved 2

UINT4
Big-endian.

Must be zeros.

Yes