Where can I find the documentation for all the magic numbers & strings?

[Guest mrdavidlaing]

The DTOs used by the API expose a number of magic numbers & strings. Where can I find documentation for these:

Specifically:

1. GetPriceBars – the INTERVAL querystring param
2. ListNewsHeadlines – the CATEGORY querystring param
3. ApiOpenPositionDTO – the Status property
4. GatewayTradeOrderDTO – the CurrencyId, StatusId, TypeId properties
5. GatewayStopLimitOrderDTO – the CurrencyId, StatusId, TypeId properties
6. ApiTradeOrderResponseDTO – the Status & StatusReason properties
7. ApiOrderResponseDTO – the Status & StatusReason properties
8. /message/lookup?lookupEntityName={LOOKUPENTITYNAME} – the {LOOKUPENTITYNAME} querystring parameter

NB: This is a wiki question & answer – please add to this question & and answer as you find new magic numbers / strings.

[Guest mrdavidlaing]

1. GetPriceBars – INTERVAL – see http://faq.labs.cityindex.com/questions/definition-of-magic-strings-and-numbers
2. ListNewsHeadlines – ??
3. ApiOpenPositionDTO – Status – seehttp://faq.labs.cityindex.com/questions/listopenpositions-meanings-of-status-magic-numbers (it seems these status messages should be a part of message lookup service, but they aren’t)
4. GatewayTradeOrderDTO – the CurrencyId, StatusId, TypeId properties
5. GatewayStopLimitOrderDTO – the CurrencyId, StatusId, TypeId properties
6. ApiTradeOrderResponseDTO – the Status & StatusReason properties (InstructionStatusReason lookup service) – seehttp://faq.labs.cityindex.com/questions/how-does-the-messaging-service-work
7. ApiOrderResponseDTO – the Status & StatusReason properties (OrderStatusReason lookup service) – see http://faq.labs.cityindex.com/questions/how-does-the-messaging-service-work
8. /message/lookup?lookupEntityName={LOOKUPENTITYNAME}&cultureId={CULTUREID*}
   • {LOOKUPENTITYNAME} ==> DTO.PROPERTY
   • OrderStatusReason ==> ApiOrderResponseDTO.StatusReason
   • InstructionStatusReason ==> ApiTradeOrderResponseDTO.StatusReason
   • OrderApplicability ==> ApiActiveStopLimitOrderDTO.Applicability
   • OrderStatus ==> ApiOrderResponseDTO.Status (only in preprod – not live yet)
   • OrderStatus ==> ApiOpenPositionDTO.Status (only in preprod – not live yet)
   • InstructionStatus ==> ApiTradeOrderResponseDTO.Status (only in preprod – not live yet)

{CULTUREID} is optional; if omitted it will default to your UserName/Session’s default culture